{ "revision": "20260506", "parameters": { "alt": { "type": "string", "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" ], "description": "Data format for response.", "default": "json", "enum": [ "json", "media", "proto" ] }, "upload_protocol": { "location": "query", "description": "Upload protocol for media (e.g. \"raw\", \"multipart\").", "type": "string" }, "access_token": { "description": "OAuth access token.", "location": "query", "type": "string" }, "$.xgafv": { "description": "V1 error format.", "enum": [ "1", "2" ], "type": "string", "location": "query", "enumDescriptions": [ "v1 error format", "v2 error format" ] }, "uploadType": { "type": "string", "location": "query", "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\")." }, "oauth_token": { "location": "query", "description": "OAuth 2.0 token for the current user.", "type": "string" }, "callback": { "location": "query", "description": "JSONP", "type": "string" }, "key": { "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.", "location": "query", "type": "string" }, "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" }, "fields": { "type": "string", "description": "Selector specifying which fields to include in a partial response.", "location": "query" }, "prettyPrint": { "location": "query", "description": "Returns response with indentations and line breaks.", "default": "true", "type": "boolean" } }, "baseUrl": "https://cloudnumberregistry.googleapis.com/", "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." } } } }, "kind": "discovery#restDescription", "rootUrl": "https://cloudnumberregistry.googleapis.com/", "discoveryVersion": "v1", "batchPath": "batch", "basePath": "", "resources": { "projects": { "resources": { "locations": { "resources": { "discoveredRanges": { "methods": { "get": { "parameters": { "name": { "required": true, "type": "string", "location": "path", "description": "Required. Name of the resource", "pattern": "^projects/[^/]+/locations/[^/]+/discoveredRanges/[^/]+$" } }, "response": { "$ref": "DiscoveredRange" }, "httpMethod": "GET", "flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/discoveredRanges/{discoveredRangesId}", "description": "Gets details of a single DiscoveredRange.", "id": "cloudnumberregistry.projects.locations.discoveredRanges.get", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "parameterOrder": [ "name" ], "path": "v1alpha/{+name}" }, "list": { "id": "cloudnumberregistry.projects.locations.discoveredRanges.list", "parameterOrder": [ "parent" ], "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "path": "v1alpha/{+parent}/discoveredRanges", "parameters": { "filter": { "type": "string", "location": "query", "description": "Optional. Filtering results." }, "pageSize": { "description": "Optional. Requested page size. Server may return fewer items than requested. If unspecified, server will pick an appropriate default.", "format": "int32", "location": "query", "type": "integer" }, "orderBy": { "description": "Optional. Hint for how to order the results.", "location": "query", "type": "string" }, "parent": { "required": true, "type": "string", "location": "path", "description": "Required. Parent value for ListDiscoveredRangesRequest", "pattern": "^projects/[^/]+/locations/[^/]+$" }, "pageToken": { "location": "query", "description": "Optional. A token identifying a page of results the server should return.", "type": "string" } }, "response": { "$ref": "ListDiscoveredRangesResponse" }, "httpMethod": "GET", "description": "Lists DiscoveredRanges in a given project and location.", "flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/discoveredRanges" }, "findFreeIpRanges": { "path": "v1alpha/{+name}:findFreeIpRanges", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "parameterOrder": [ "name" ], "id": "cloudnumberregistry.projects.locations.discoveredRanges.findFreeIpRanges", "flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/discoveredRanges/{discoveredRangesId}:findFreeIpRanges", "description": "Finds free IP ranges in a single DiscoveredRange.", "httpMethod": "GET", "parameters": { "name": { "location": "path", "required": true, "type": "string", "description": "Required. Name of the DiscoveredRange.", "pattern": "^projects/[^/]+/locations/[^/]+/discoveredRanges/[^/]+$" }, "cidrPrefixLength": { "description": "Required. The prefix length of the free IP ranges to find.", "format": "int32", "location": "query", "type": "integer" }, "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 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" }, "rangeCount": { "description": "Optional. The number of free IP ranges to find.", "format": "int32", "location": "query", "type": "integer" } }, "response": { "$ref": "FindDiscoveredRangeFreeIpRangesResponse" } }, "showUtilization": { "parameters": { "name": { "required": true, "type": "string", "location": "path", "description": "Required. Name of the resource", "pattern": "^projects/[^/]+/locations/[^/]+/discoveredRanges/[^/]+$" } }, "response": { "$ref": "ShowDiscoveredRangeUtilizationResponse" }, "flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/discoveredRanges/{discoveredRangesId}:showUtilization", "description": "Gets the details of a single DiscoveredRange and its utilization.", "httpMethod": "GET", "id": "cloudnumberregistry.projects.locations.discoveredRanges.showUtilization", "path": "v1alpha/{+name}:showUtilization", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "parameterOrder": [ "name" ] } } }, "customRanges": { "methods": { "delete": { "httpMethod": "DELETE", "description": "Deletes a single CustomRange.", "flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/customRanges/{customRangesId}", "parameters": { "name": { "description": "Required. Name of the resource", "pattern": "^projects/[^/]+/locations/[^/]+/customRanges/[^/]+$", "required": true, "type": "string", "location": "path" }, "requestId": { "type": "string", "location": "query", "description": "Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes 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)." }, "force": { "type": "boolean", "description": "Optional. If set to true, all associated resources will be deleted.", "location": "query" } }, "response": { "$ref": "Operation" }, "parameterOrder": [ "name" ], "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "path": "v1alpha/{+name}", "id": "cloudnumberregistry.projects.locations.customRanges.delete" }, "list": { "parameters": { "filter": { "location": "query", "description": "Optional. Filtering results.", "type": "string" }, "pageSize": { "description": "Optional. Requested page size. Server may return fewer items than requested. If unspecified, server will pick an appropriate default.", "format": "int32", "location": "query", "type": "integer" }, "orderBy": { "type": "string", "description": "Optional. Hint for how to order the results.", "location": "query" }, "parent": { "description": "Required. Parent value for ListCustomRangesRequest", "pattern": "^projects/[^/]+/locations/[^/]+$", "required": true, "type": "string", "location": "path" }, "pageToken": { "type": "string", "description": "Optional. A token identifying a page of results the server should return.", "location": "query" } }, "response": { "$ref": "ListCustomRangesResponse" }, "httpMethod": "GET", "description": "Lists CustomRanges in a given project and location.", "flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/customRanges", "id": "cloudnumberregistry.projects.locations.customRanges.list", "parameterOrder": [ "parent" ], "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "path": "v1alpha/{+parent}/customRanges" }, "findFreeIpRanges": { "path": "v1alpha/{+name}:findFreeIpRanges", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "parameterOrder": [ "name" ], "id": "cloudnumberregistry.projects.locations.customRanges.findFreeIpRanges", "flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/customRanges/{customRangesId}:findFreeIpRanges", "description": "Finds free IP ranges in a single CustomRange.", "httpMethod": "GET", "parameters": { "rangeCount": { "type": "integer", "description": "Optional. The number of free IP ranges to find.", "format": "int32", "location": "query" }, "name": { "location": "path", "required": true, "type": "string", "description": "Required. Name of the CustomRange.", "pattern": "^projects/[^/]+/locations/[^/]+/customRanges/[^/]+$" }, "cidrPrefixLength": { "location": "query", "description": "Required. The prefix length of the free IP ranges to find.", "format": "int32", "type": "integer" }, "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 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" } }, "response": { "$ref": "FindCustomRangeFreeIpRangesResponse" } }, "get": { "httpMethod": "GET", "flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/customRanges/{customRangesId}", "description": "Gets details of a single CustomRange.", "parameters": { "name": { "description": "Required. Name of the resource", "pattern": "^projects/[^/]+/locations/[^/]+/customRanges/[^/]+$", "required": true, "type": "string", "location": "path" } }, "response": { "$ref": "CustomRange" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "parameterOrder": [ "name" ], "path": "v1alpha/{+name}", "id": "cloudnumberregistry.projects.locations.customRanges.get" }, "showUtilization": { "description": "Gets the details of a single CustomRange and its utilization.", "flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/customRanges/{customRangesId}:showUtilization", "httpMethod": "GET", "parameters": { "name": { "description": "Required. Name of the resource", "pattern": "^projects/[^/]+/locations/[^/]+/customRanges/[^/]+$", "location": "path", "required": true, "type": "string" } }, "response": { "$ref": "ShowCustomRangeUtilizationResponse" }, "path": "v1alpha/{+name}:showUtilization", "parameterOrder": [ "name" ], "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "id": "cloudnumberregistry.projects.locations.customRanges.showUtilization" }, "create": { "id": "cloudnumberregistry.projects.locations.customRanges.create", "parameterOrder": [ "parent" ], "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "path": "v1alpha/{+parent}/customRanges", "parameters": { "customRangeId": { "location": "query", "description": "Required. Id of the requesting object.", "type": "string" }, "requestId": { "type": "string", "location": "query", "description": "Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes since the first request. For example, consider a situation where you make an initial request and 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)." }, "parent": { "location": "path", "required": true, "type": "string", "description": "Required. Value for parent.", "pattern": "^projects/[^/]+/locations/[^/]+$" } }, "response": { "$ref": "Operation" }, "request": { "$ref": "CustomRange" }, "httpMethod": "POST", "description": "Creates a new CustomRange in a given project and location.", "flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/customRanges" }, "patch": { "parameters": { "updateMask": { "location": "query", "description": "Optional. Field mask is used to specify the fields to be overwritten in the CustomRange 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.", "format": "google-fieldmask", "type": "string" }, "requestId": { "type": "string", "location": "query", "description": "Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes since the first request. For example, consider a situation where you make an initial request and 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)." }, "name": { "location": "path", "required": true, "type": "string", "description": "Required. Identifier. name of resource", "pattern": "^projects/[^/]+/locations/[^/]+/customRanges/[^/]+$" } }, "response": { "$ref": "Operation" }, "httpMethod": "PATCH", "request": { "$ref": "CustomRange" }, "flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/customRanges/{customRangesId}", "description": "Updates the parameters of a single CustomRange.", "id": "cloudnumberregistry.projects.locations.customRanges.patch", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "parameterOrder": [ "name" ], "path": "v1alpha/{+name}" } } }, "ipamAdminScopes": { "methods": { "disable": { "id": "cloudnumberregistry.projects.locations.ipamAdminScopes.disable", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "parameterOrder": [ "name" ], "path": "v1alpha/{+name}:disable", "parameters": { "name": { "location": "path", "required": true, "type": "string", "description": "Required. Name of the resource", "pattern": "^projects/[^/]+/locations/[^/]+/ipamAdminScopes/[^/]+$" } }, "response": { "$ref": "Operation" }, "httpMethod": "POST", "request": { "$ref": "DisableIpamAdminScopeRequest" }, "flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/ipamAdminScopes/{ipamAdminScopesId}:disable", "description": "Disables a single IpamAdminScope." }, "list": { "parameters": { "parent": { "required": true, "type": "string", "location": "path", "description": "Required. Parent value for ListIpamAdminScopesRequest", "pattern": "^projects/[^/]+/locations/[^/]+$" }, "pageToken": { "description": "Optional. A token identifying a page of results the server should return.", "location": "query", "type": "string" }, "pageSize": { "location": "query", "description": "Optional. Requested page size. Server may return fewer items than requested. If unspecified, server will pick an appropriate default.", "format": "int32", "type": "integer" }, "filter": { "type": "string", "description": "Optional. Filtering results", "location": "query" }, "orderBy": { "location": "query", "description": "Optional. Hint for how to order the results", "type": "string" } }, "response": { "$ref": "ListIpamAdminScopesResponse" }, "description": "List all IPAM admin scopes in a given project and location.", "flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/ipamAdminScopes", "httpMethod": "GET", "id": "cloudnumberregistry.projects.locations.ipamAdminScopes.list", "path": "v1alpha/{+parent}/ipamAdminScopes", "parameterOrder": [ "parent" ], "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] }, "checkAvailability": { "id": "cloudnumberregistry.projects.locations.ipamAdminScopes.checkAvailability", "path": "v1alpha/{+parent}/ipamAdminScopes:checkAvailability", "parameterOrder": [ "parent" ], "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "parameters": { "parent": { "description": "Required. Parent value for the IpamAdminScopes.", "pattern": "^projects/[^/]+/locations/[^/]+$", "location": "path", "required": true, "type": "string" }, "scopes": { "type": "string", "location": "query", "description": "Required. The scopes of the IpamAdminScopes to look for.", "repeated": true } }, "response": { "$ref": "CheckAvailabilityIpamAdminScopesResponse" }, "description": "Checks the availability of IPAM admin scopes in a given project and location.", "flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/ipamAdminScopes:checkAvailability", "httpMethod": "GET" }, "delete": { "httpMethod": "DELETE", "flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/ipamAdminScopes/{ipamAdminScopesId}", "description": "Deletes a single IpamAdminScope.", "parameters": { "force": { "type": "boolean", "location": "query", "description": "Optional. If set to true, all associated resources will be deleted." }, "requestId": { "type": "string", "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).", "location": "query" }, "name": { "description": "Required. Name of the resource", "pattern": "^projects/[^/]+/locations/[^/]+/ipamAdminScopes/[^/]+$", "required": true, "type": "string", "location": "path" } }, "response": { "$ref": "Operation" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "parameterOrder": [ "name" ], "path": "v1alpha/{+name}", "id": "cloudnumberregistry.projects.locations.ipamAdminScopes.delete" }, "cleanup": { "request": { "$ref": "CleanupIpamAdminScopeRequest" }, "httpMethod": "POST", "description": "Cleans up a single IpamAdminScope.", "flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/ipamAdminScopes/{ipamAdminScopesId}:cleanup", "parameters": { "name": { "description": "Required. Name of the resource", "pattern": "^projects/[^/]+/locations/[^/]+/ipamAdminScopes/[^/]+$", "required": true, "type": "string", "location": "path" } }, "response": { "$ref": "Operation" }, "parameterOrder": [ "name" ], "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "path": "v1alpha/{+name}:cleanup", "id": "cloudnumberregistry.projects.locations.ipamAdminScopes.cleanup" }, "create": { "flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/ipamAdminScopes", "description": "Creates a new IpamAdminScope in a given project and location.", "httpMethod": "POST", "request": { "$ref": "IpamAdminScope" }, "parameters": { "parent": { "description": "Required. Value for parent.", "pattern": "^projects/[^/]+/locations/[^/]+$", "location": "path", "required": true, "type": "string" }, "ipamAdminScopeId": { "type": "string", "description": "Required. Id of the requesting object.", "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 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).", "location": "query", "type": "string" } }, "response": { "$ref": "Operation" }, "path": "v1alpha/{+parent}/ipamAdminScopes", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "parameterOrder": [ "parent" ], "id": "cloudnumberregistry.projects.locations.ipamAdminScopes.create" }, "patch": { "parameterOrder": [ "name" ], "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "path": "v1alpha/{+name}", "id": "cloudnumberregistry.projects.locations.ipamAdminScopes.patch", "request": { "$ref": "IpamAdminScope" }, "httpMethod": "PATCH", "description": "Updates the parameters of a single IpamAdminScope.", "flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/ipamAdminScopes/{ipamAdminScopesId}", "parameters": { "updateMask": { "type": "string", "location": "query", "description": "Optional. Field mask is used to specify the fields to be overwritten in the IpamAdminScope 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.", "format": "google-fieldmask" }, "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 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" }, "name": { "required": true, "type": "string", "location": "path", "description": "Required. Identifier. name of resource", "pattern": "^projects/[^/]+/locations/[^/]+/ipamAdminScopes/[^/]+$" } }, "response": { "$ref": "Operation" } }, "get": { "parameterOrder": [ "name" ], "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "path": "v1alpha/{+name}", "id": "cloudnumberregistry.projects.locations.ipamAdminScopes.get", "httpMethod": "GET", "description": "Gets details of a single IpamAdminScope.", "flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/ipamAdminScopes/{ipamAdminScopesId}", "parameters": { "name": { "description": "Required. Name of the resource", "pattern": "^projects/[^/]+/locations/[^/]+/ipamAdminScopes/[^/]+$", "location": "path", "required": true, "type": "string" } }, "response": { "$ref": "IpamAdminScope" } } } }, "operations": { "methods": { "get": { "id": "cloudnumberregistry.projects.locations.operations.get", "path": "v1alpha/{+name}", "parameterOrder": [ "name" ], "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "parameters": { "name": { "description": "The name of the operation resource.", "pattern": "^projects/[^/]+/locations/[^/]+/operations/[^/]+$", "location": "path", "required": true, "type": "string" } }, "response": { "$ref": "Operation" }, "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.", "flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/operations/{operationsId}", "httpMethod": "GET" }, "delete": { "parameters": { "name": { "required": true, "type": "string", "location": "path", "description": "The name of the operation resource to be deleted.", "pattern": "^projects/[^/]+/locations/[^/]+/operations/[^/]+$" } }, "response": { "$ref": "Empty" }, "httpMethod": "DELETE", "flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/operations/{operationsId}", "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`.", "id": "cloudnumberregistry.projects.locations.operations.delete", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "parameterOrder": [ "name" ], "path": "v1alpha/{+name}" }, "cancel": { "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "parameterOrder": [ "name" ], "path": "v1alpha/{+name}:cancel", "id": "cloudnumberregistry.projects.locations.operations.cancel", "httpMethod": "POST", "request": { "$ref": "CancelOperationRequest" }, "flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/operations/{operationsId}: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`.", "parameters": { "name": { "required": true, "type": "string", "location": "path", "description": "The name of the operation resource to be cancelled.", "pattern": "^projects/[^/]+/locations/[^/]+/operations/[^/]+$" } }, "response": { "$ref": "Empty" } }, "list": { "id": "cloudnumberregistry.projects.locations.operations.list", "path": "v1alpha/{+name}/operations", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "parameterOrder": [ "name" ], "parameters": { "pageSize": { "type": "integer", "description": "The standard list page size.", "format": "int32", "location": "query" }, "name": { "required": true, "type": "string", "location": "path", "description": "The name of the operation's parent resource.", "pattern": "^projects/[^/]+/locations/[^/]+$" }, "filter": { "type": "string", "location": "query", "description": "The standard list filter." }, "pageToken": { "type": "string", "location": "query", "description": "The standard list page token." }, "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.", "location": "query", "type": "boolean" } }, "response": { "$ref": "ListOperationsResponse" }, "flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/operations", "description": "Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.", "httpMethod": "GET" } } }, "registryBooks": { "methods": { "create": { "flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/registryBooks", "description": "Creates a new RegistryBook in a given project and location.", "httpMethod": "POST", "request": { "$ref": "RegistryBook" }, "parameters": { "parent": { "description": "Required. Value for parent.", "pattern": "^projects/[^/]+/locations/[^/]+$", "location": "path", "required": true, "type": "string" }, "registryBookId": { "type": "string", "description": "Required. Id of the requesting object.", "location": "query" }, "requestId": { "type": "string", "location": "query", "description": "Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes since the first request. For example, consider a situation where you make an initial request and 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)." } }, "response": { "$ref": "Operation" }, "path": "v1alpha/{+parent}/registryBooks", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "parameterOrder": [ "parent" ], "id": "cloudnumberregistry.projects.locations.registryBooks.create" }, "patch": { "parameters": { "updateMask": { "type": "string", "location": "query", "description": "Optional. Field mask is used to specify the fields to be overwritten in the RegistryBook 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.", "format": "google-fieldmask" }, "requestId": { "type": "string", "location": "query", "description": "Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes since the first request. For example, consider a situation where you make an initial request and 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)." }, "name": { "location": "path", "required": true, "type": "string", "description": "Required. Identifier. name of resource", "pattern": "^projects/[^/]+/locations/[^/]+/registryBooks/[^/]+$" } }, "response": { "$ref": "Operation" }, "flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/registryBooks/{registryBooksId}", "description": "Updates the parameters of a single RegistryBook.", "httpMethod": "PATCH", "request": { "$ref": "RegistryBook" }, "id": "cloudnumberregistry.projects.locations.registryBooks.patch", "path": "v1alpha/{+name}", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "parameterOrder": [ "name" ] }, "get": { "parameterOrder": [ "name" ], "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "path": "v1alpha/{+name}", "id": "cloudnumberregistry.projects.locations.registryBooks.get", "httpMethod": "GET", "description": "Gets details of a single RegistryBook.", "flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/registryBooks/{registryBooksId}", "parameters": { "name": { "location": "path", "required": true, "type": "string", "description": "Required. Name of the resource", "pattern": "^projects/[^/]+/locations/[^/]+/registryBooks/[^/]+$" }, "view": { "location": "query", "enumDescriptions": [ "Unspecified view. Defaults to BASIC.", "Basic view.", "Full view. Includes the same data as the BASIC view.", "Aggregate includes data about the child resources of the RegistryBook." ], "type": "string", "description": "Optional. The view of the RegistryBook.", "enum": [ "REGISTRY_BOOK_VIEW_UNSPECIFIED", "BASIC", "FULL", "AGGREGATE" ] } }, "response": { "$ref": "RegistryBook" } }, "searchIpResources": { "request": { "$ref": "SearchIpResourcesRequest" }, "httpMethod": "POST", "description": "Searches IP resources in a given RegistryBook.", "flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/registryBooks/{registryBooksId}:searchIpResources", "parameters": { "name": { "description": "Required. The name of the RegistryBook to search in.", "pattern": "^projects/[^/]+/locations/[^/]+/registryBooks/[^/]+$", "required": true, "type": "string", "location": "path" } }, "response": { "$ref": "SearchIpResourcesResponse" }, "parameterOrder": [ "name" ], "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "path": "v1alpha/{+name}:searchIpResources", "id": "cloudnumberregistry.projects.locations.registryBooks.searchIpResources" }, "list": { "parameters": { "filter": { "description": "Optional. Filtering results", "location": "query", "type": "string" }, "pageSize": { "type": "integer", "location": "query", "description": "Optional. Requested page size. Server may return fewer items than requested. If unspecified, server will pick an appropriate default.", "format": "int32" }, "orderBy": { "type": "string", "description": "Optional. Hint for how to order the results", "location": "query" }, "view": { "description": "Optional. The view of the RegistryBook.", "enum": [ "REGISTRY_BOOK_VIEW_UNSPECIFIED", "BASIC", "FULL", "AGGREGATE" ], "type": "string", "enumDescriptions": [ "Unspecified view. Defaults to BASIC.", "Basic view.", "Full view. Includes the same data as the BASIC view.", "Aggregate includes data about the child resources of the RegistryBook." ], "location": "query" }, "parent": { "description": "Required. Parent value for ListRegistryBooksRequest", "pattern": "^projects/[^/]+/locations/[^/]+$", "required": true, "type": "string", "location": "path" }, "pageToken": { "description": "Optional. A token identifying a page of results the server should return.", "location": "query", "type": "string" } }, "response": { "$ref": "ListRegistryBooksResponse" }, "httpMethod": "GET", "description": "Lists RegistryBooks in a given project and location.", "flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/registryBooks", "id": "cloudnumberregistry.projects.locations.registryBooks.list", "parameterOrder": [ "parent" ], "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "path": "v1alpha/{+parent}/registryBooks" }, "delete": { "id": "cloudnumberregistry.projects.locations.registryBooks.delete", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "parameterOrder": [ "name" ], "path": "v1alpha/{+name}", "parameters": { "force": { "description": "Optional. If set to true, all associated resources will be deleted.", "location": "query", "type": "boolean" }, "name": { "required": true, "type": "string", "location": "path", "description": "Required. Name of the resource", "pattern": "^projects/[^/]+/locations/[^/]+/registryBooks/[^/]+$" }, "requestId": { "type": "string", "location": "query", "description": "Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes 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)." } }, "response": { "$ref": "Operation" }, "httpMethod": "DELETE", "flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/registryBooks/{registryBooksId}", "description": "Deletes a single RegistryBook." } } }, "realms": { "methods": { "list": { "id": "cloudnumberregistry.projects.locations.realms.list", "path": "v1alpha/{+parent}/realms", "parameterOrder": [ "parent" ], "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "parameters": { "parent": { "location": "path", "required": true, "type": "string", "description": "Required. Parent value for ListRealmsRequest", "pattern": "^projects/[^/]+/locations/[^/]+$" }, "pageToken": { "location": "query", "description": "Optional. A token identifying a page of results the server should return.", "type": "string" }, "orderBy": { "location": "query", "description": "Optional. Hint for how to order the results", "type": "string" }, "view": { "description": "Optional. The view of the Realm.", "enum": [ "REALM_VIEW_UNSPECIFIED", "BASIC", "FULL", "AGGREGATE" ], "location": "query", "enumDescriptions": [ "Unspecified view. Defaults to BASIC.", "Basic view.", "Full view. Includes the same data as the BASIC view.", "Aggregate includes data about the child resources of the Realm." ], "type": "string" }, "pageSize": { "location": "query", "description": "Optional. Requested page size. Server may return fewer items than requested. If unspecified, server will pick an appropriate default.", "format": "int32", "type": "integer" }, "filter": { "type": "string", "description": "Optional. Filtering results", "location": "query" } }, "response": { "$ref": "ListRealmsResponse" }, "description": "Lists Realms in a given project and location.", "flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/realms", "httpMethod": "GET" }, "delete": { "id": "cloudnumberregistry.projects.locations.realms.delete", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "parameterOrder": [ "name" ], "path": "v1alpha/{+name}", "parameters": { "requestId": { "type": "string", "location": "query", "description": "Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes after the first request." }, "name": { "description": "Required. Name of the resource", "pattern": "^projects/[^/]+/locations/[^/]+/realms/[^/]+$", "required": true, "type": "string", "location": "path" }, "force": { "type": "boolean", "location": "query", "description": "Optional. If set to true, all associated resources will be deleted." } }, "response": { "$ref": "Operation" }, "httpMethod": "DELETE", "flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/realms/{realmsId}", "description": "Deletes a single Realm." }, "create": { "parameters": { "parent": { "description": "Required. Value for parent.", "pattern": "^projects/[^/]+/locations/[^/]+$", "required": true, "type": "string", "location": "path" }, "requestId": { "type": "string", "location": "query", "description": "Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes since the first request." }, "realmId": { "location": "query", "description": "Required. Id of the requesting object.", "type": "string" } }, "response": { "$ref": "Operation" }, "request": { "$ref": "Realm" }, "httpMethod": "POST", "description": "Creates a new Realm in a given project and location.", "flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/realms", "id": "cloudnumberregistry.projects.locations.realms.create", "parameterOrder": [ "parent" ], "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "path": "v1alpha/{+parent}/realms" }, "patch": { "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "parameterOrder": [ "name" ], "path": "v1alpha/{+name}", "id": "cloudnumberregistry.projects.locations.realms.patch", "httpMethod": "PATCH", "request": { "$ref": "Realm" }, "flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/realms/{realmsId}", "description": "Updates the parameters of a single Realm.", "parameters": { "updateMask": { "location": "query", "description": "Optional. Field mask is used to specify the fields to be overwritten in the Realm resource by the update.", "format": "google-fieldmask", "type": "string" }, "name": { "location": "path", "required": true, "type": "string", "description": "Required. Identifier. Unique name/ID of the realm", "pattern": "^projects/[^/]+/locations/[^/]+/realms/[^/]+$" }, "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.", "location": "query", "type": "string" } }, "response": { "$ref": "Operation" } }, "get": { "httpMethod": "GET", "flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/realms/{realmsId}", "description": "Gets details of a single Realm.", "parameters": { "name": { "description": "Required. Name of the resource", "pattern": "^projects/[^/]+/locations/[^/]+/realms/[^/]+$", "location": "path", "required": true, "type": "string" }, "view": { "location": "query", "enumDescriptions": [ "Unspecified view. Defaults to BASIC.", "Basic view.", "Full view. Includes the same data as the BASIC view.", "Aggregate includes data about the child resources of the Realm." ], "type": "string", "description": "Optional. The view of the Realm.", "enum": [ "REALM_VIEW_UNSPECIFIED", "BASIC", "FULL", "AGGREGATE" ] } }, "response": { "$ref": "Realm" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "parameterOrder": [ "name" ], "path": "v1alpha/{+name}", "id": "cloudnumberregistry.projects.locations.realms.get" } } } }, "methods": { "list": { "id": "cloudnumberregistry.projects.locations.list", "path": "v1alpha/{+name}/locations", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "parameterOrder": [ "name" ], "parameters": { "pageToken": { "type": "string", "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." }, "pageSize": { "description": "The maximum number of results to return. If not set, the service selects a default.", "format": "int32", "location": "query", "type": "integer" }, "name": { "location": "path", "required": true, "type": "string", "description": "The resource that owns the locations collection, if applicable.", "pattern": "^projects/[^/]+$" }, "filter": { "type": "string", "description": "A filter to narrow down results to a preferred subset. The filtering language accepts strings like `\"displayName=tokyo\"`, and is documented in more detail in [AIP-160](https://google.aip.dev/160).", "location": "query" }, "extraLocationTypes": { "location": "query", "description": "Optional. Do not use this field unless explicitly documented otherwise. This is primarily for internal usage.", "repeated": true, "type": "string" } }, "response": { "$ref": "ListLocationsResponse" }, "flatPath": "v1alpha/projects/{projectsId}/locations", "description": "Lists information about the supported locations for this service. This method lists locations based on the resource scope provided in the ListLocationsRequest.name field: * **Global locations**: If `name` is empty, the method lists the public locations available to all projects. * **Project-specific locations**: If `name` follows the format `projects/{project}`, the method lists locations visible to that specific project. This includes public, private, or other project-specific locations enabled for the project. For gRPC and client library implementations, the resource name is passed as the `name` field. For direct service calls, the resource name is incorporated into the request path based on the specific service implementation and version.", "httpMethod": "GET" }, "get": { "parameters": { "name": { "description": "Resource name for the location.", "pattern": "^projects/[^/]+/locations/[^/]+$", "required": true, "type": "string", "location": "path" } }, "response": { "$ref": "Location" }, "flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}", "description": "Gets information about a location.", "httpMethod": "GET", "id": "cloudnumberregistry.projects.locations.get", "path": "v1alpha/{+name}", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "parameterOrder": [ "name" ] } } } } } }, "description": "", "fullyEncodeReservedExpansion": true, "ownerDomain": "google.com", "title": "Cloud Number Registry API", "ownerName": "Google", "icons": { "x16": "http://www.google.com/images/icons/product/search-16.gif", "x32": "http://www.google.com/images/icons/product/search-32.gif" }, "schemas": { "ListIpamAdminScopesResponse": { "properties": { "nextPageToken": { "description": "A token identifying a page of results the server should return.", "type": "string" }, "unreachable": { "type": "array", "items": { "type": "string" }, "description": "Locations that could not be reached." }, "ipamAdminScopes": { "type": "array", "items": { "$ref": "IpamAdminScope" }, "description": "The list of IpamAdminScope" } }, "id": "ListIpamAdminScopesResponse", "description": "Message for response to listing ipamAdminScopes", "type": "object" }, "SearchIpResourcesRequest": { "properties": { "query": { "type": "string", "description": "Optional. Search query. This string filters resources in an AIP-160-like format. It has some limitations. You can only specify top level conjunctions or attribute level negations. Each restriction can only be used once except the attribute restriction. The available restrictions for ranges are: - `realm`: The realm name to search in. - `ip_address`: The IP address to search for within ranges. - `ip_version`: The IP version to filter by (e.g., \"IPV4\", \"IPV6\"). - `parent_range`: The parent range of the range to search for. - `attribute_text`: The attribute text to search for within ranges. - `attribute`: The attribute key and value to filter by. The available restrictions for realms are: - `ip_version`: The IP version to search for. Only one of attribute_text or multiple attribute filters can be specified. Examples: - `realm=test-realm` - `realm=test-realm AND ip_address=10.0.0.0` - `realm=test-realm AND ip_version=IPV6` - `realm=test-realm AND attribute_text=test` - `ip_address=10.0.0.0 AND attribute:(key1=value1) AND attribute:(key2=value2)` - `attribute_text=test AND parent_range=projects/123/locations/global/discoveredRanges/test-parent-range`" }, "pageSize": { "type": "integer", "description": "Optional. Requested page size. Server may return fewer items than requested. If unspecified, server will pick an appropriate default.", "format": "int32" }, "showUtilization": { "type": "boolean", "description": "Optional. Whether to show the utilization of the ranges in the response." }, "orderBy": { "description": "Optional. Hint for how to order the results", "type": "string" }, "searchResourceTypes": { "type": "array", "items": { "enumDescriptions": [ "Unspecified search type.", "Search for ranges.", "Search for realms." ], "enum": [ "SEARCH_RESOURCE_TYPE_UNSPECIFIED", "RANGES", "REALMS" ], "type": "string" }, "description": "Optional. The type of resources to search for. If not specified, the server will return ranges." }, "pageToken": { "description": "Optional. A token identifying a page of results the server should return.", "type": "string" } }, "id": "SearchIpResourcesRequest", "description": "Message for searching IP resources", "type": "object" }, "ListLocationsResponse": { "type": "object", "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." }, "ListRegistryBooksResponse": { "id": "ListRegistryBooksResponse", "description": "Message for response to listing RegistryBooks", "properties": { "registryBooks": { "description": "The list of RegistryBook", "type": "array", "items": { "$ref": "RegistryBook" } }, "nextPageToken": { "description": "A token identifying a page of results the server should return.", "type": "string" }, "unreachable": { "description": "Locations that could not be reached.", "type": "array", "items": { "type": "string" } } }, "type": "object" }, "SearchIpResourcesResponse": { "type": "object", "id": "SearchIpResourcesResponse", "description": "Message for response to searching IP resources", "properties": { "ranges": { "description": "Deprecated: Use results field instead. The list of ranges matching the search query.", "deprecated": true, "type": "array", "items": { "$ref": "Range" } }, "results": { "description": "The list of results matching the search query.", "type": "array", "items": { "$ref": "SearchIpResourcesResult" } }, "nextPageToken": { "description": "A token identifying a page of results the server should return.", "type": "string" }, "unreachable": { "type": "array", "items": { "type": "string" }, "description": "Locations that could not be reached." } } }, "DiscoveryMetadata": { "id": "DiscoveryMetadata", "description": "Discovery metadata of the discovered resource.", "properties": { "sourceSubId": { "type": "string", "description": "Output only. A single source resource can be the source of multiple CNR resources. This sub_id is used to distinguish between the different CNR resources derived from the same upstream resource. For example, a single subnetwork can be the source of multiple ranges, one for each protocol. In this case, the sub_id could be \"private-ipv4\" or \"private-ipv6\".", "readOnly": true }, "resource": { "type": "string", "description": "Output only. The resource name of the discovered resource, should be API-agnostic. Example: \"projects/{project_number}/networks/{network_id}\".", "readOnly": true }, "resourceUri": { "type": "string", "description": "Output only. The resource uri of the discovered resource.", "readOnly": true }, "sourceId": { "type": "string", "readOnly": true, "description": "Output only. The canonical google.aip.dev/122 name of the source resource." }, "eventTime": { "type": "string", "description": "Output only. The time when the event happened.", "format": "google-datetime", "readOnly": true }, "createTime": { "type": "string", "description": "Output only. The time when the resource was created.", "format": "google-datetime", "readOnly": true }, "updateTime": { "description": "Output only. The time when the resource was last modified.", "format": "google-datetime", "readOnly": true, "type": "string" }, "state": { "type": "string", "enumDescriptions": [ "Unspecified state.", "The resource is in an invalid state.", "The resource exists in the backing store (is not tombstoned or completely missing) and there were no failures reading out the resource level metadata.", "Resource does not exist or has been deleted or soft-deleted.", "There was an error reading out the resource level metadata." ], "description": "Output only. The state of the resource.", "enum": [ "RESOURCE_STATE_UNSPECIFIED", "INVALID", "EXISTS", "DOES_NOT_EXIST", "ERROR" ], "readOnly": true } }, "type": "object" }, "RealmAggregatedData": { "type": "object", "id": "RealmAggregatedData", "description": "Aggregated data for the Realm.", "properties": { "discoveredRangesCount": { "description": "Output only. Number of discovered ranges in the Realm.", "format": "int32", "readOnly": true, "type": "integer" }, "customRangesCount": { "type": "integer", "readOnly": true, "description": "Output only. Number of custom ranges in the Realm.", "format": "int32" } } }, "ListDiscoveredRangesResponse": { "properties": { "nextPageToken": { "description": "A token identifying a page of results the server should return.", "type": "string" }, "unreachable": { "type": "array", "items": { "type": "string" }, "description": "Locations that could not be reached." }, "discoveredRanges": { "description": "The list of DiscoveredRange", "type": "array", "items": { "$ref": "DiscoveredRange" } } }, "id": "ListDiscoveredRangesResponse", "description": "Message for response to listing DiscoveredRanges", "type": "object" }, "OperationMetadata": { "id": "OperationMetadata", "description": "Represents the metadata of the long-running operation.", "properties": { "endTime": { "type": "string", "readOnly": true, "description": "Output only. The time the operation finished running.", "format": "google-datetime" }, "requestedCancellation": { "type": "boolean", "readOnly": true, "description": "Output only. Identifies whether the user has requested cancellation of the operation. Operations that have been cancelled successfully have Operation.error value with a google.rpc.Status.code of 1, corresponding to `Code.CANCELLED`." }, "target": { "description": "Output only. Server-defined resource path for the target of the operation.", "readOnly": true, "type": "string" }, "statusMessage": { "type": "string", "readOnly": true, "description": "Output only. Human-readable status of the operation, if any." }, "apiVersion": { "type": "string", "readOnly": true, "description": "Output only. API version used to start the operation." }, "createTime": { "description": "Output only. The time the operation was created.", "format": "google-datetime", "readOnly": true, "type": "string" }, "verb": { "type": "string", "description": "Output only. Name of the verb executed by the operation.", "readOnly": true } }, "type": "object" }, "CleanupIpamAdminScopeRequest": { "type": "object", "id": "CleanupIpamAdminScopeRequest", "description": "Message for cleaning up a IpamAdminScope", "properties": { "requestId": { "type": "string", "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)." } } }, "ShowCustomRangeUtilizationResponse": { "id": "ShowCustomRangeUtilizationResponse", "description": "Message for the response to getting the utilization of a CustomRange", "properties": { "customRange": { "description": "The CustomRange resource.", "$ref": "CustomRange" }, "rangeUtilization": { "description": "The utilization of the CustomRange.", "$ref": "RangeUtilization" } }, "type": "object" }, "FindCustomRangeFreeIpRangesResponse": { "id": "FindCustomRangeFreeIpRangesResponse", "description": "Message for the response to finding free IP ranges.", "properties": { "freeIpCidrRanges": { "type": "array", "items": { "type": "string" }, "readOnly": true, "description": "Output only. Free IP CIDR ranges found in the CustomRange." } }, "type": "object" }, "AggregatedData": { "type": "object", "properties": { "uniqueScopesCount": { "type": "integer", "description": "Output only. Number of scopes unique to the RegistryBook.", "format": "int32", "readOnly": true }, "discoveredRealmsCount": { "type": "integer", "readOnly": true, "description": "Output only. Number of discovered realms in the RegistryBook.", "format": "int32" }, "customRealmsCount": { "description": "Output only. Number of custom realms in the RegistryBook.", "format": "int32", "readOnly": true, "type": "integer" }, "discoveredRangesCount": { "type": "integer", "readOnly": true, "description": "Output only. Number of discovered ranges in the RegistryBook.", "format": "int32" }, "customRangesCount": { "type": "integer", "readOnly": true, "description": "Output only. Number of custom ranges in the RegistryBook.", "format": "int32" } }, "id": "AggregatedData", "description": "Aggregated data for the RegistryBook." }, "Realm": { "properties": { "name": { "description": "Required. Identifier. Unique name/ID of the realm", "type": "string" }, "ipVersion": { "type": "string", "description": "Optional. IP version of the realm.", "enumDescriptions": [ "Unspecified IP version.", "IPv4 IP version.", "IPv6 IP version." ], "enum": [ "IP_VERSION_UNSPECIFIED", "IPV4", "IPV6" ] }, "managementType": { "type": "string", "description": "Required. Management type of realm.", "enumDescriptions": [ "Unspecified management type.", "Managed by Cloud Number Registry.", "Managed by User." ], "enum": [ "MANAGEMENT_TYPE_UNSPECIFIED", "CNR", "USER" ] }, "trafficType": { "type": "string", "description": "Required. Traffic type of realm.", "enumDescriptions": [ "Unspecified traffic type.", "Unset traffic type.", "Internet traffic.", "Private traffic.", "Linklocal traffic." ], "enum": [ "TRAFFIC_TYPE_UNSPECIFIED", "UNSET", "INTERNET", "PRIVATE", "LINKLOCAL" ] }, "labels": { "type": "object", "additionalProperties": { "type": "string" }, "description": "Optional. Labels as key value pairs" }, "discoveryMetadata": { "description": "Output only. Discovery metadata of the realm.", "readOnly": true, "$ref": "DiscoveryMetadata" }, "createTime": { "type": "string", "description": "Output only. [Output only] Create time stamp", "format": "google-datetime", "readOnly": true }, "updateTime": { "type": "string", "readOnly": true, "description": "Output only. [Output only] Update time stamp", "format": "google-datetime" }, "aggregatedData": { "$ref": "RealmAggregatedData", "readOnly": true, "description": "Output only. Aggregated data for the Realm. Populated only when the view is AGGREGATE." }, "registryBook": { "type": "string", "description": "Required. URI of the registry book that claims the realm." } }, "id": "Realm", "description": "Message describing Realm object", "type": "object" }, "Location": { "id": "Location", "description": "A resource that represents a Google Cloud location.", "properties": { "metadata": { "description": "Service-specific metadata. For example the available capacity at the given location.", "type": "object", "additionalProperties": { "type": "any", "description": "Properties of the object. Contains field @type with type URL." } }, "displayName": { "type": "string", "description": "The friendly name for this location, typically a nearby city name. For example, \"Tokyo\"." }, "labels": { "type": "object", "additionalProperties": { "type": "string" }, "description": "Cross-service attributes for the location. For example {\"cloud.googleapis.com/region\": \"us-east1\"}" }, "name": { "type": "string", "description": "Resource name for the location, which may vary between implementations. For example: `\"projects/example-project/locations/us-east1\"`" }, "locationId": { "type": "string", "description": "The canonical id for this location. For example: `\"us-east1\"`." } }, "type": "object" }, "CustomRange": { "properties": { "ipv6CidrRange": { "type": "string", "description": "Optional. The IPv6 CIDR range of the CustomRange." }, "registryBook": { "description": "Output only. The registry book of the CustomRange. This field is inherited from the realm or parent range depending on which one is specified.", "readOnly": true, "type": "string" }, "name": { "description": "Required. Identifier. name of resource", "type": "string" }, "realm": { "description": "Optional. The realm of the CustomRange. The realm must be in the same project as the custom range. Do not allow setting realm if parent range is specified, since the realm should be inherited from the parent range. Format must follow this pattern: projects/{project}/locations/{location}/realms/{realm}", "type": "string" }, "parentRange": { "type": "string", "description": "Optional. The parent range of the CustomRange. Do not allow setting parent range if realm is specified. Format must follow this pattern: projects/{project}/locations/{location}/customRanges/{custom_range}" }, "description": { "description": "Optional. Description of the CustomRange.", "type": "string" }, "attributes": { "type": "array", "items": { "$ref": "Attribute" }, "description": "Optional. The attributes of the CustomRange." }, "ipv4CidrRange": { "description": "Optional. The IPv4 CIDR range of the CustomRange.", "type": "string" }, "labels": { "description": "Optional. Labels as key value pairs", "type": "object", "additionalProperties": { "type": "string" } } }, "id": "CustomRange", "description": "Message describing CustomRange object", "type": "object" }, "RangeUtilization": { "type": "object", "id": "RangeUtilization", "description": "Message for the utilization of an IP range", "properties": { "totalConsumed": { "type": "string", "readOnly": true, "description": "Output only. The total number of IP addresses consumed in the range." }, "totalProduced": { "description": "Output only. The total number of IP addresses produced in the range.", "readOnly": true, "type": "string" }, "usage": { "type": "number", "description": "Output only. The usage of the range as a percentage. This is marked as optional so that we have presence tracking and API responses show 0.0 instead of NULL.", "format": "double", "readOnly": true } } }, "CheckAvailabilityIpamAdminScopesResponse": { "type": "object", "id": "CheckAvailabilityIpamAdminScopesResponse", "description": "Message for response to checking the availability of IpamAdminScopes", "properties": { "scopeAvailabilities": { "description": "The details of the requested scopes.", "type": "array", "items": { "$ref": "IpamAdminScopeAvailability" } } } }, "DiscoveredRange": { "id": "DiscoveredRange", "description": "Message describing DiscoveredRange object", "properties": { "createTime": { "description": "Output only. [Output only] Create time stamp", "format": "google-datetime", "readOnly": true, "type": "string" }, "registryBook": { "type": "string", "readOnly": true, "description": "Output only. The registry book of the DiscoveredRange." }, "name": { "type": "string", "description": "Required. Identifier. Name of the DiscoveredRange." }, "parentRange": { "description": "Optional. The parent range of the DiscoveredRange.", "type": "string" }, "description": { "type": "string", "description": "Optional. Description of the DiscoveredRange." }, "attributes": { "description": "Optional. The attributes of the DiscoveredRange.", "type": "array", "items": { "$ref": "Attribute" } }, "discoveryMetadata": { "description": "Output only. Owner metadata for this DiscoveredRange. A unique set of metadata is associated with each DiscoveredRange. If an IP range is shared by multiple resources (e.g., an Address resource and an Instance resource, or multiple ForwardingRules),separate DiscoveredRanges are created, each with a distinct owner. This ensures each DiscoveredRange has its own unique set of attributes, labels, create time and update time.", "readOnly": true, "$ref": "DiscoveryMetadata" }, "updateTime": { "type": "string", "description": "Output only. [Output only] Update time stamp", "format": "google-datetime", "readOnly": true }, "childCidrOverlapAllowed": { "type": "boolean", "description": "Output only. If true, allow child ranges of this range to overlap with each other.", "readOnly": true }, "ipv6CidrRange": { "description": "Optional. The IPv6 CIDR range of the DiscoveredRange.", "type": "string" }, "realm": { "type": "string", "description": "Optional. The realm of the DiscoveredRange." }, "ipv4CidrRange": { "type": "string", "description": "Optional. The IPv4 CIDR range of the DiscoveredRange." }, "labels": { "description": "Optional. Labels as key value pairs", "type": "object", "additionalProperties": { "type": "string" } } }, "type": "object" }, "Empty": { "type": "object", "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); }", "properties": {} }, "DisableIpamAdminScopeRequest": { "id": "DisableIpamAdminScopeRequest", "description": "Message for disabling a IpamAdminScope", "properties": { "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 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" } }, "type": "object" }, "IpamAdminScope": { "properties": { "labels": { "description": "Optional. Labels as key value pairs", "type": "object", "additionalProperties": { "type": "string" } }, "state": { "enumDescriptions": [ "Unspecified state.", "Internal failure.", "Failure.", "Setup in progress.", "Ready for use.", "Deleting in progress.", "Updating.", "Recovering.", "Disabled.", "Deleting completed.", "Cleanup in progress.", "Ready for deletion." ], "type": "string", "description": "Output only. State of resource discovery pipeline.", "enum": [ "DISCOVERY_PIPELINE_STATE_UNSPECIFIED", "INTERNAL_FAILURE", "FAILED", "SETUP_IN_PROGRESS", "READY_FOR_USE", "DELETING_IN_PROGRESS", "UPDATING", "RECOVERING", "DISABLED", "DELETION_COMPLETED", "CLEANUP_IN_PROGRESS", "READY_FOR_DELETION" ], "readOnly": true }, "createTime": { "type": "string", "readOnly": true, "description": "Output only. [Output only] Create time stamp", "format": "google-datetime" }, "updateTime": { "readOnly": true, "description": "Output only. [Output only] Update time stamp", "format": "google-datetime", "type": "string" }, "enabledAddonPlatforms": { "description": "Required. Addon platforms that are enabled for this IPAM admin scope. Cloud Number Registry only discovers the IP addresses from the enabled platforms.", "type": "array", "items": { "enumDescriptions": [ "Unspecified add-on platform.", "Google Compute Engine.", "Deprecated: Use COMPUTE_ENGINE instead." ], "enum": [ "ADD_ON_PLATFORM_UNSPECIFIED", "COMPUTE_ENGINE", "GCE" ], "type": "string", "enumDeprecated": [ false, false, true ] } }, "scopes": { "type": "array", "items": { "type": "string" }, "description": "Required. Administrative scopes enabled for IP address discovery and management. For example, \"organizations/1234567890\". Minimum of 1 scope is required. In preview, only one organization scope is allowed." }, "name": { "description": "Required. Identifier. name of resource", "type": "string" } }, "id": "IpamAdminScope", "description": "Message describing IpamAdminScope object", "type": "object" }, "RegistryBook": { "id": "RegistryBook", "description": "Message describing RegistryBook object", "properties": { "aggregatedData": { "readOnly": true, "description": "Output only. Aggregated data for the RegistryBook. Populated only when the view is AGGREGATE.", "$ref": "AggregatedData" }, "createTime": { "type": "string", "description": "Output only. [Output only] Create time stamp", "format": "google-datetime", "readOnly": true }, "updateTime": { "readOnly": true, "description": "Output only. [Output only] Update time stamp", "format": "google-datetime", "type": "string" }, "claimedScopes": { "type": "array", "items": { "type": "string" }, "description": "Optional. List of scopes claimed by the RegistryBook. In Preview, Only project scope is supported. Each scope is in the format of projects/{project}. Each scope can only be claimed once." }, "labels": { "type": "object", "additionalProperties": { "type": "string" }, "description": "Optional. Labels as key value pairs" }, "isDefault": { "readOnly": true, "description": "Output only. Whether the RegistryBook is the default one.", "type": "boolean" }, "name": { "type": "string", "description": "Required. Identifier. name of resource" } }, "type": "object" }, "Range": { "type": "object", "properties": { "customRange": { "description": "A custom range.", "$ref": "CustomRange" }, "discoveredRange": { "description": "A discovered range.", "$ref": "DiscoveredRange" }, "utilization": { "description": "The utilization of the range.", "$ref": "RangeUtilization" } }, "id": "Range", "description": "Message describing either a CustomRange or a DiscoveredRange." }, "ListRealmsResponse": { "properties": { "realms": { "description": "The list of Realm", "type": "array", "items": { "$ref": "Realm" } }, "nextPageToken": { "description": "A token identifying a page of results the server should return.", "type": "string" }, "unreachable": { "type": "array", "items": { "type": "string" }, "description": "Locations that could not be reached." } }, "id": "ListRealmsResponse", "description": "Message for response to listing Realms", "type": "object" }, "FindDiscoveredRangeFreeIpRangesResponse": { "properties": { "freeIpCidrRanges": { "type": "array", "items": { "type": "string" }, "description": "Output only. Free IP CIDR ranges found in the DiscoveredRange.", "readOnly": true } }, "id": "FindDiscoveredRangeFreeIpRangesResponse", "description": "Message for the response to finding free IP ranges.", "type": "object" }, "ListCustomRangesResponse": { "id": "ListCustomRangesResponse", "description": "Message for response to listing CustomRanges", "properties": { "nextPageToken": { "type": "string", "description": "A token identifying a page of results the server should return." }, "unreachable": { "description": "Locations that could not be reached.", "type": "array", "items": { "type": "string" } }, "customRanges": { "type": "array", "items": { "$ref": "CustomRange" }, "description": "The list of CustomRange" } }, "type": "object" }, "Operation": { "type": "object", "id": "Operation", "description": "This resource represents a long-running operation that is the result of a network API call.", "properties": { "done": { "type": "boolean", "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." }, "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": { "description": "Properties of the object. Contains field @type with type URL.", "type": "any" } }, "response": { "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", "additionalProperties": { "type": "any", "description": "Properties of the object. Contains field @type with type URL." } }, "name": { "type": "string", "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}`." }, "error": { "description": "The error result of the operation in case of failure or cancellation.", "$ref": "Status" } } }, "Attribute": { "properties": { "key": { "description": "Required. Key of attribute", "type": "string" }, "value": { "description": "Required. Value of attribute", "type": "string" } }, "id": "Attribute", "description": "Message describing Attribute object", "type": "object" }, "CancelOperationRequest": { "properties": {}, "id": "CancelOperationRequest", "description": "The request message for Operations.CancelOperation.", "type": "object" }, "SearchIpResourcesResult": { "type": "object", "properties": { "realm": { "description": "A realm matching the search query.", "$ref": "Realm" }, "range": { "description": "A range matching the search query.", "$ref": "Range" } }, "id": "SearchIpResourcesResult", "description": "A result matching the search query, which can be either a range or a realm." }, "ListOperationsResponse": { "id": "ListOperationsResponse", "description": "The response message for Operations.ListOperations.", "properties": { "operations": { "type": "array", "items": { "$ref": "Operation" }, "description": "A list of operations that matches the specified filter in the request." }, "nextPageToken": { "type": "string", "description": "The standard List next-page token." }, "unreachable": { "type": "array", "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": "object" }, "Status": { "id": "Status", "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://cloud.google.com/apis/design/errors).", "properties": { "details": { "description": "A list of messages that carry the error details. There is a common set of message types for APIs to use.", "type": "array", "items": { "type": "object", "additionalProperties": { "type": "any", "description": "Properties of the object. Contains field @type with type URL." } } }, "code": { "description": "The status code, which should be an enum value of google.rpc.Code.", "format": "int32", "type": "integer" }, "message": { "type": "string", "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": "object" }, "IpamAdminScopeAvailability": { "properties": { "scope": { "description": "The scope of the IpamAdminScope.", "type": "string" }, "availability": { "description": "The availability of the scope.", "enumDescriptions": [ "Unspecified availability.", "The scope is available.", "The scope is not available." ], "enum": [ "AVAILABILITY_UNSPECIFIED", "AVAILABLE", "UNAVAILABLE" ], "type": "string" }, "adminProject": { "description": "The admin project of the IpamAdminScope if it exists.", "format": "int64", "type": "string" } }, "id": "IpamAdminScopeAvailability", "description": "Message for the availability of an IpamAdminScope", "type": "object" }, "ShowDiscoveredRangeUtilizationResponse": { "type": "object", "id": "ShowDiscoveredRangeUtilizationResponse", "description": "Message for the response to getting the utilization of a DiscoveredRange", "properties": { "rangeUtilization": { "description": "The utilization of the DiscoveredRange.", "$ref": "RangeUtilization" }, "discoveredRange": { "description": "The DiscoveredRange resource.", "$ref": "DiscoveredRange" } } } }, "id": "cloudnumberregistry:v1alpha", "documentationLink": "https://docs.cloud.google.com/number-registry/reference/rest", "version_module": true, "protocol": "rest", "servicePath": "", "mtlsRootUrl": "https://cloudnumberregistry.mtls.googleapis.com/", "version": "v1alpha", "name": "cloudnumberregistry", "canonicalName": "Cloud Number Registry" }