{ "version_module": true, "title": "Cloud Number Registry API", "documentationLink": "https://docs.cloud.google.com/number-registry/reference/rest", "servicePath": "", "version": "v1alpha", "id": "cloudnumberregistry:v1alpha", "kind": "discovery#restDescription", "fullyEncodeReservedExpansion": true, "mtlsRootUrl": "https://cloudnumberregistry.mtls.googleapis.com/", "basePath": "", "protocol": "rest", "baseUrl": "https://cloudnumberregistry.googleapis.com/", "batchPath": "batch", "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." } } } }, "revision": "20260617", "ownerName": "Google", "ownerDomain": "google.com", "resources": { "projects": { "resources": { "locations": { "methods": { "get": { "flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "path": "v1alpha/{+name}", "httpMethod": "GET", "description": "Gets information about a location.", "parameters": { "name": { "description": "Resource name for the location.", "pattern": "^projects/[^/]+/locations/[^/]+$", "required": true, "location": "path", "type": "string" } }, "response": { "$ref": "Location" }, "id": "cloudnumberregistry.projects.locations.get", "parameterOrder": [ "name" ] }, "list": { "path": "v1alpha/{+name}/locations", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "flatPath": "v1alpha/projects/{projectsId}/locations", "parameterOrder": [ "name" ], "id": "cloudnumberregistry.projects.locations.list", "parameters": { "filter": { "description": "A filter to narrow down results to a preferred subset. The filtering language accepts strings like `\"displayName=tokyo\"`, and is documented in more detail in [AIP-160](https://google.aip.dev/160).", "location": "query", "type": "string" }, "pageSize": { "description": "The maximum number of results to return. If not set, the service selects a default.", "location": "query", "type": "integer", "format": "int32" }, "pageToken": { "description": "A page token received from the `next_page_token` field in the response. Send that page token to receive the subsequent page.", "location": "query", "type": "string" }, "extraLocationTypes": { "description": "Optional. Do not use this field unless explicitly documented otherwise. This is primarily for internal usage.", "location": "query", "type": "string", "repeated": true }, "name": { "description": "The resource that owns the locations collection, if applicable.", "pattern": "^projects/[^/]+$", "required": true, "location": "path", "type": "string" } }, "response": { "$ref": "ListLocationsResponse" }, "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" } }, "resources": { "customRanges": { "methods": { "findFreeIpRanges": { "path": "v1alpha/{+name}:findFreeIpRanges", "flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/customRanges/{customRangesId}:findFreeIpRanges", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "id": "cloudnumberregistry.projects.locations.customRanges.findFreeIpRanges", "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).", "location": "query", "type": "string" }, "cidrPrefixLength": { "format": "int32", "description": "Required. The prefix length of the free IP ranges to find.", "location": "query", "type": "integer" }, "name": { "location": "path", "type": "string", "pattern": "^projects/[^/]+/locations/[^/]+/customRanges/[^/]+$", "required": true, "description": "Required. The resource name of the CustomRange to search within." }, "rangeCount": { "description": "Optional. The number of free IP ranges to find.", "location": "query", "type": "integer", "format": "int32" } }, "response": { "$ref": "FindCustomRangeFreeIpRangesResponse" }, "parameterOrder": [ "name" ], "httpMethod": "GET", "description": "Finds free IP ranges in a single CustomRange." }, "patch": { "path": "v1alpha/{+name}", "request": { "$ref": "CustomRange" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/customRanges/{customRangesId}", "parameterOrder": [ "name" ], "id": "cloudnumberregistry.projects.locations.customRanges.patch", "parameters": { "updateMask": { "format": "google-fieldmask", "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.", "location": "query", "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).", "location": "query", "type": "string" }, "name": { "pattern": "^projects/[^/]+/locations/[^/]+/customRanges/[^/]+$", "required": true, "description": "Required. Identifier. The resource name of the CustomRange, in the format `projects/{project}/locations/{location}/customRanges/{custom_range}`.", "location": "path", "type": "string" } }, "response": { "$ref": "Operation" }, "description": "Updates the parameters of a single CustomRange.", "httpMethod": "PATCH" }, "list": { "id": "cloudnumberregistry.projects.locations.customRanges.list", "parameters": { "filter": { "description": "Optional. Filter expression to filter the results.", "location": "query", "type": "string" }, "pageSize": { "format": "int32", "description": "Optional. Requested page size. Server may return fewer items than requested. If unspecified, server will pick an appropriate default.", "location": "query", "type": "integer" }, "pageToken": { "description": "Optional. A token identifying a page of results the server should return.", "location": "query", "type": "string" }, "parent": { "description": "Required. The parent resource name, for example `projects/*/locations/*`.", "pattern": "^projects/[^/]+/locations/[^/]+$", "required": true, "location": "path", "type": "string" }, "orderBy": { "description": "Optional. Hint for how to order the results.", "location": "query", "type": "string" } }, "response": { "$ref": "ListCustomRangesResponse" }, "parameterOrder": [ "parent" ], "httpMethod": "GET", "description": "Lists CustomRanges in a given project and location.", "path": "v1alpha/{+parent}/customRanges", "flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/customRanges", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] }, "delete": { "httpMethod": "DELETE", "description": "Deletes a single CustomRange.", "id": "cloudnumberregistry.projects.locations.customRanges.delete", "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 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", "type": "string" }, "name": { "pattern": "^projects/[^/]+/locations/[^/]+/customRanges/[^/]+$", "required": true, "description": "Required. The resource name of the CustomRange to delete.", "location": "path", "type": "string" }, "force": { "description": "Optional. If set to true, all associated resources will be deleted.", "location": "query", "type": "boolean" } }, "response": { "$ref": "Operation" }, "parameterOrder": [ "name" ], "flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/customRanges/{customRangesId}", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "path": "v1alpha/{+name}" }, "get": { "path": "v1alpha/{+name}", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/customRanges/{customRangesId}", "parameterOrder": [ "name" ], "id": "cloudnumberregistry.projects.locations.customRanges.get", "parameters": { "name": { "description": "Required. The resource name of the CustomRange to retrieve.", "pattern": "^projects/[^/]+/locations/[^/]+/customRanges/[^/]+$", "required": true, "location": "path", "type": "string" } }, "response": { "$ref": "CustomRange" }, "description": "Gets details of a single CustomRange.", "httpMethod": "GET" }, "showUtilization": { "path": "v1alpha/{+name}:showUtilization", "flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/customRanges/{customRangesId}:showUtilization", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "parameters": { "name": { "location": "path", "type": "string", "pattern": "^projects/[^/]+/locations/[^/]+/customRanges/[^/]+$", "required": true, "description": "Required. The resource name of the CustomRange." } }, "response": { "$ref": "ShowCustomRangeUtilizationResponse" }, "id": "cloudnumberregistry.projects.locations.customRanges.showUtilization", "parameterOrder": [ "name" ], "httpMethod": "GET", "description": "Gets the details of a single CustomRange and its utilization." }, "create": { "description": "Creates a new CustomRange in a given project and location.", "httpMethod": "POST", "parameterOrder": [ "parent" ], "id": "cloudnumberregistry.projects.locations.customRanges.create", "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).", "location": "query", "type": "string" }, "parent": { "location": "path", "type": "string", "description": "Required. The parent resource name where the CustomRange will be created.", "pattern": "^projects/[^/]+/locations/[^/]+$", "required": true }, "customRangeId": { "description": "Required. The ID to use for the CustomRange, which will become the final segment of the resource name.", "location": "query", "type": "string" } }, "response": { "$ref": "Operation" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/customRanges", "path": "v1alpha/{+parent}/customRanges", "request": { "$ref": "CustomRange" } } } }, "registryBooks": { "methods": { "get": { "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/registryBooks/{registryBooksId}", "path": "v1alpha/{+name}", "description": "Gets details of a single RegistryBook.", "httpMethod": "GET", "parameterOrder": [ "name" ], "parameters": { "name": { "location": "path", "type": "string", "pattern": "^projects/[^/]+/locations/[^/]+/registryBooks/[^/]+$", "required": true, "description": "Required. The resource name of the RegistryBook to retrieve." }, "view": { "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." ], "description": "Optional. The view of the RegistryBook to retrieve.", "location": "query", "type": "string", "enum": [ "REGISTRY_BOOK_VIEW_UNSPECIFIED", "BASIC", "FULL", "AGGREGATE" ] } }, "response": { "$ref": "RegistryBook" }, "id": "cloudnumberregistry.projects.locations.registryBooks.get" }, "create": { "request": { "$ref": "RegistryBook" }, "path": "v1alpha/{+parent}/registryBooks", "flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/registryBooks", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "parameters": { "registryBookId": { "description": "Required. The ID to use for the RegistryBook, which will become the final segment of the resource name.", "location": "query", "type": "string" }, "parent": { "location": "path", "type": "string", "pattern": "^projects/[^/]+/locations/[^/]+$", "required": true, "description": "Required. The parent resource name where the RegistryBook will be created." }, "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" }, "id": "cloudnumberregistry.projects.locations.registryBooks.create", "parameterOrder": [ "parent" ], "httpMethod": "POST", "description": "Creates a new RegistryBook in a given project and location." }, "searchIpResources": { "httpMethod": "POST", "description": "Searches IP resources in a given RegistryBook.", "id": "cloudnumberregistry.projects.locations.registryBooks.searchIpResources", "parameters": { "name": { "location": "path", "type": "string", "description": "Required. The resource name of the RegistryBook to search in.", "pattern": "^projects/[^/]+/locations/[^/]+/registryBooks/[^/]+$", "required": true } }, "response": { "$ref": "SearchIpResourcesResponse" }, "parameterOrder": [ "name" ], "flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/registryBooks/{registryBooksId}:searchIpResources", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "path": "v1alpha/{+name}:searchIpResources", "request": { "$ref": "SearchIpResourcesRequest" } }, "delete": { "path": "v1alpha/{+name}", "flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/registryBooks/{registryBooksId}", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "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 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", "type": "string" }, "name": { "location": "path", "type": "string", "pattern": "^projects/[^/]+/locations/[^/]+/registryBooks/[^/]+$", "required": true, "description": "Required. The resource name of the RegistryBook to delete." }, "force": { "description": "Optional. If set to true, all associated resources will be deleted.", "location": "query", "type": "boolean" } }, "response": { "$ref": "Operation" }, "id": "cloudnumberregistry.projects.locations.registryBooks.delete", "parameterOrder": [ "name" ], "httpMethod": "DELETE", "description": "Deletes a single RegistryBook." }, "list": { "httpMethod": "GET", "description": "Lists RegistryBooks in a given project and location.", "parameters": { "pageSize": { "description": "Optional. Requested page size. Server may return fewer items than requested. If unspecified, server will pick an appropriate default.", "location": "query", "type": "integer", "format": "int32" }, "filter": { "description": "Optional. Filter expression to filter the results.", "location": "query", "type": "string" }, "orderBy": { "description": "Optional. Hint for how to order the results.", "location": "query", "type": "string" }, "pageToken": { "description": "Optional. A token identifying a page of results the server should return.", "location": "query", "type": "string" }, "parent": { "description": "Required. The parent resource name, for example `projects/*/locations/*`.", "pattern": "^projects/[^/]+/locations/[^/]+$", "required": true, "location": "path", "type": "string" }, "view": { "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." ], "description": "Optional. The view of the RegistryBook to retrieve.", "location": "query", "type": "string", "enum": [ "REGISTRY_BOOK_VIEW_UNSPECIFIED", "BASIC", "FULL", "AGGREGATE" ] } }, "response": { "$ref": "ListRegistryBooksResponse" }, "id": "cloudnumberregistry.projects.locations.registryBooks.list", "parameterOrder": [ "parent" ], "flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/registryBooks", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "path": "v1alpha/{+parent}/registryBooks" }, "patch": { "request": { "$ref": "RegistryBook" }, "path": "v1alpha/{+name}", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/registryBooks/{registryBooksId}", "parameterOrder": [ "name" ], "parameters": { "name": { "location": "path", "type": "string", "pattern": "^projects/[^/]+/locations/[^/]+/registryBooks/[^/]+$", "required": true, "description": "Required. Identifier. The resource name of the RegistryBook." }, "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" }, "updateMask": { "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.", "location": "query", "type": "string", "format": "google-fieldmask" } }, "response": { "$ref": "Operation" }, "id": "cloudnumberregistry.projects.locations.registryBooks.patch", "description": "Updates the parameters of a single RegistryBook.", "httpMethod": "PATCH" } } }, "operations": { "methods": { "get": { "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/operations/{operationsId}", "path": "v1alpha/{+name}", "description": "Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.", "httpMethod": "GET", "parameterOrder": [ "name" ], "parameters": { "name": { "pattern": "^projects/[^/]+/locations/[^/]+/operations/[^/]+$", "required": true, "description": "The name of the operation resource.", "location": "path", "type": "string" } }, "response": { "$ref": "Operation" }, "id": "cloudnumberregistry.projects.locations.operations.get" }, "delete": { "path": "v1alpha/{+name}", "flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/operations/{operationsId}", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "parameters": { "name": { "pattern": "^projects/[^/]+/locations/[^/]+/operations/[^/]+$", "required": true, "description": "The name of the operation resource to be deleted.", "location": "path", "type": "string" } }, "response": { "$ref": "Empty" }, "id": "cloudnumberregistry.projects.locations.operations.delete", "parameterOrder": [ "name" ], "httpMethod": "DELETE", "description": "Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`." }, "list": { "id": "cloudnumberregistry.projects.locations.operations.list", "parameters": { "pageToken": { "description": "The standard list page token.", "location": "query", "type": "string" }, "name": { "location": "path", "type": "string", "description": "The name of the operation's parent resource.", "pattern": "^projects/[^/]+/locations/[^/]+$", "required": true }, "filter": { "description": "The standard list filter.", "location": "query", "type": "string" }, "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" }, "pageSize": { "description": "The standard list page size.", "location": "query", "type": "integer", "format": "int32" } }, "response": { "$ref": "ListOperationsResponse" }, "parameterOrder": [ "name" ], "httpMethod": "GET", "description": "Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.", "path": "v1alpha/{+name}/operations", "flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/operations", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] }, "cancel": { "parameterOrder": [ "name" ], "parameters": { "name": { "description": "The name of the operation resource to be cancelled.", "pattern": "^projects/[^/]+/locations/[^/]+/operations/[^/]+$", "required": true, "location": "path", "type": "string" } }, "response": { "$ref": "Empty" }, "id": "cloudnumberregistry.projects.locations.operations.cancel", "description": "Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`.", "httpMethod": "POST", "request": { "$ref": "CancelOperationRequest" }, "path": "v1alpha/{+name}:cancel", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/operations/{operationsId}:cancel" } } }, "realms": { "methods": { "patch": { "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/realms/{realmsId}", "path": "v1alpha/{+name}", "request": { "$ref": "Realm" }, "description": "Updates the parameters of a single Realm.", "httpMethod": "PATCH", "parameterOrder": [ "name" ], "id": "cloudnumberregistry.projects.locations.realms.patch", "parameters": { "updateMask": { "format": "google-fieldmask", "description": "Optional. Field mask is used to specify the fields to be overwritten in the Realm resource by the update.", "location": "query", "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.", "location": "query", "type": "string" }, "name": { "pattern": "^projects/[^/]+/locations/[^/]+/realms/[^/]+$", "required": true, "description": "Required. Identifier. The resource name of the Realm.", "location": "path", "type": "string" } }, "response": { "$ref": "Operation" } }, "list": { "parameterOrder": [ "parent" ], "parameters": { "pageSize": { "description": "Optional. Requested page size. Server may return fewer items than requested. If unspecified, server will pick an appropriate default.", "location": "query", "type": "integer", "format": "int32" }, "filter": { "description": "Optional. Filter expression to filter the results.", "location": "query", "type": "string" }, "orderBy": { "description": "Optional. Hint for how to order the results.", "location": "query", "type": "string" }, "parent": { "location": "path", "type": "string", "description": "Required. The parent resource name, for example `projects/*/locations/*`.", "pattern": "^projects/[^/]+/locations/[^/]+$", "required": true }, "view": { "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." ], "description": "Optional. The view of the Realm to retrieve.", "location": "query", "type": "string", "enum": [ "REALM_VIEW_UNSPECIFIED", "BASIC", "FULL", "AGGREGATE" ] }, "pageToken": { "description": "Optional. A token identifying a page of results the server should return.", "location": "query", "type": "string" } }, "response": { "$ref": "ListRealmsResponse" }, "id": "cloudnumberregistry.projects.locations.realms.list", "description": "Lists Realms in a given project and location.", "httpMethod": "GET", "path": "v1alpha/{+parent}/realms", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/realms" }, "delete": { "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/realms/{realmsId}", "path": "v1alpha/{+name}", "description": "Deletes a single Realm.", "httpMethod": "DELETE", "parameterOrder": [ "name" ], "id": "cloudnumberregistry.projects.locations.realms.delete", "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 after the first request.", "location": "query", "type": "string" }, "name": { "location": "path", "type": "string", "pattern": "^projects/[^/]+/locations/[^/]+/realms/[^/]+$", "required": true, "description": "Required. The resource name of the Realm to delete." }, "force": { "description": "Optional. If set to true, all associated resources will be deleted.", "location": "query", "type": "boolean" } }, "response": { "$ref": "Operation" } }, "get": { "description": "Gets details of a single Realm.", "httpMethod": "GET", "parameterOrder": [ "name" ], "parameters": { "name": { "location": "path", "type": "string", "pattern": "^projects/[^/]+/locations/[^/]+/realms/[^/]+$", "required": true, "description": "Required. The resource name of the Realm to retrieve." }, "view": { "location": "query", "type": "string", "enum": [ "REALM_VIEW_UNSPECIFIED", "BASIC", "FULL", "AGGREGATE" ], "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." ], "description": "Optional. The view of the Realm to retrieve." } }, "response": { "$ref": "Realm" }, "id": "cloudnumberregistry.projects.locations.realms.get", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/realms/{realmsId}", "path": "v1alpha/{+name}" }, "create": { "request": { "$ref": "Realm" }, "path": "v1alpha/{+parent}/realms", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/realms", "parameterOrder": [ "parent" ], "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.", "location": "query", "type": "string" }, "parent": { "description": "Required. The parent resource name where the Realm will be created.", "pattern": "^projects/[^/]+/locations/[^/]+$", "required": true, "location": "path", "type": "string" }, "realmId": { "description": "Required. The ID to use for the Realm, which will become the final segment of the resource name.", "location": "query", "type": "string" } }, "response": { "$ref": "Operation" }, "id": "cloudnumberregistry.projects.locations.realms.create", "description": "Creates a new Realm in a given project and location.", "httpMethod": "POST" } } }, "ipamAdminScopes": { "methods": { "disable": { "path": "v1alpha/{+name}:disable", "request": { "$ref": "DisableIpamAdminScopeRequest" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/ipamAdminScopes/{ipamAdminScopesId}:disable", "parameterOrder": [ "name" ], "id": "cloudnumberregistry.projects.locations.ipamAdminScopes.disable", "parameters": { "name": { "location": "path", "type": "string", "description": "Required. The resource name of the IpamAdminScope to disable.", "pattern": "^projects/[^/]+/locations/[^/]+/ipamAdminScopes/[^/]+$", "required": true } }, "response": { "$ref": "Operation" }, "description": "Disables a single IpamAdminScope.", "httpMethod": "POST" }, "get": { "path": "v1alpha/{+name}", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/ipamAdminScopes/{ipamAdminScopesId}", "parameterOrder": [ "name" ], "id": "cloudnumberregistry.projects.locations.ipamAdminScopes.get", "parameters": { "name": { "pattern": "^projects/[^/]+/locations/[^/]+/ipamAdminScopes/[^/]+$", "required": true, "description": "Required. The resource name of the IpamAdminScope to retrieve.", "location": "path", "type": "string" } }, "response": { "$ref": "IpamAdminScope" }, "description": "Gets details of a single IpamAdminScope.", "httpMethod": "GET" }, "create": { "description": "Creates a new IpamAdminScope in a given project and location.", "httpMethod": "POST", "parameterOrder": [ "parent" ], "parameters": { "parent": { "description": "Required. The parent resource name where the IpamAdminScope will be created.", "pattern": "^projects/[^/]+/locations/[^/]+$", "required": true, "location": "path", "type": "string" }, "ipamAdminScopeId": { "description": "Required. The ID to use for the IpamAdminScope, which will become the final segment of the resource name.", "location": "query", "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).", "location": "query", "type": "string" } }, "response": { "$ref": "Operation" }, "id": "cloudnumberregistry.projects.locations.ipamAdminScopes.create", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/ipamAdminScopes", "request": { "$ref": "IpamAdminScope" }, "path": "v1alpha/{+parent}/ipamAdminScopes" }, "cleanup": { "flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/ipamAdminScopes/{ipamAdminScopesId}:cleanup", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "path": "v1alpha/{+name}:cleanup", "request": { "$ref": "CleanupIpamAdminScopeRequest" }, "httpMethod": "POST", "description": "Cleans up a single IpamAdminScope.", "id": "cloudnumberregistry.projects.locations.ipamAdminScopes.cleanup", "parameters": { "name": { "location": "path", "type": "string", "description": "Required. The resource name of the IpamAdminScope to clean up.", "pattern": "^projects/[^/]+/locations/[^/]+/ipamAdminScopes/[^/]+$", "required": true } }, "response": { "$ref": "Operation" }, "parameterOrder": [ "name" ] }, "checkAvailability": { "description": "Checks the availability of IpamAdminScopes in a given project and location.", "httpMethod": "GET", "parameterOrder": [ "parent" ], "parameters": { "parent": { "description": "Required. The parent resource name, for example `projects/*/locations/*`.", "pattern": "^projects/[^/]+/locations/[^/]+$", "required": true, "location": "path", "type": "string" }, "scopes": { "repeated": true, "description": "Required. The administrative scopes to check for availability.", "location": "query", "type": "string" } }, "response": { "$ref": "CheckAvailabilityIpamAdminScopesResponse" }, "id": "cloudnumberregistry.projects.locations.ipamAdminScopes.checkAvailability", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/ipamAdminScopes:checkAvailability", "path": "v1alpha/{+parent}/ipamAdminScopes:checkAvailability" }, "patch": { "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/ipamAdminScopes/{ipamAdminScopesId}", "request": { "$ref": "IpamAdminScope" }, "path": "v1alpha/{+name}", "description": "Updates the parameters of a single IpamAdminScope.", "httpMethod": "PATCH", "parameterOrder": [ "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).", "location": "query", "type": "string" }, "updateMask": { "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.", "location": "query", "type": "string", "format": "google-fieldmask" }, "name": { "location": "path", "type": "string", "description": "Required. Identifier. The resource name of the IpamAdminScope.", "pattern": "^projects/[^/]+/locations/[^/]+/ipamAdminScopes/[^/]+$", "required": true } }, "response": { "$ref": "Operation" }, "id": "cloudnumberregistry.projects.locations.ipamAdminScopes.patch" }, "list": { "description": "Lists IpamAdminScopes in a given project and location.", "httpMethod": "GET", "parameterOrder": [ "parent" ], "parameters": { "filter": { "description": "Optional. Filter expression to filter the results.", "location": "query", "type": "string" }, "pageSize": { "description": "Optional. Requested page size. Server may return fewer items than requested. If unspecified, server will pick an appropriate default.", "location": "query", "type": "integer", "format": "int32" }, "pageToken": { "description": "Optional. A token identifying a page of results the server should return.", "location": "query", "type": "string" }, "parent": { "location": "path", "type": "string", "description": "Required. The parent resource name, for example `projects/*/locations/*`.", "pattern": "^projects/[^/]+/locations/[^/]+$", "required": true }, "orderBy": { "description": "Optional. Hint for how to order the results.", "location": "query", "type": "string" } }, "response": { "$ref": "ListIpamAdminScopesResponse" }, "id": "cloudnumberregistry.projects.locations.ipamAdminScopes.list", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/ipamAdminScopes", "path": "v1alpha/{+parent}/ipamAdminScopes" }, "delete": { "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 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", "type": "string" }, "name": { "location": "path", "type": "string", "description": "Required. The resource name of the IpamAdminScope to delete.", "pattern": "^projects/[^/]+/locations/[^/]+/ipamAdminScopes/[^/]+$", "required": true }, "force": { "description": "Optional. If set to true, all associated resources will be deleted.", "location": "query", "type": "boolean" } }, "response": { "$ref": "Operation" }, "id": "cloudnumberregistry.projects.locations.ipamAdminScopes.delete", "parameterOrder": [ "name" ], "httpMethod": "DELETE", "description": "Deletes a single IpamAdminScope.", "path": "v1alpha/{+name}", "flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/ipamAdminScopes/{ipamAdminScopesId}", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] } } }, "discoveredRanges": { "methods": { "list": { "path": "v1alpha/{+parent}/discoveredRanges", "flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/discoveredRanges", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "id": "cloudnumberregistry.projects.locations.discoveredRanges.list", "parameters": { "filter": { "description": "Optional. Filter expression to filter the results.", "location": "query", "type": "string" }, "pageSize": { "description": "Optional. Requested page size. Server may return fewer items than requested. If unspecified, server will pick an appropriate default.", "location": "query", "type": "integer", "format": "int32" }, "pageToken": { "description": "Optional. A token identifying a page of results the server should return.", "location": "query", "type": "string" }, "parent": { "description": "Required. The parent resource name, for example `projects/*/locations/*`.", "pattern": "^projects/[^/]+/locations/[^/]+$", "required": true, "location": "path", "type": "string" }, "orderBy": { "description": "Optional. Hint for how to order the results.", "location": "query", "type": "string" } }, "response": { "$ref": "ListDiscoveredRangesResponse" }, "parameterOrder": [ "parent" ], "httpMethod": "GET", "description": "Lists DiscoveredRanges in a given project and location." }, "get": { "description": "Gets details of a single DiscoveredRange.", "httpMethod": "GET", "parameterOrder": [ "name" ], "id": "cloudnumberregistry.projects.locations.discoveredRanges.get", "parameters": { "name": { "location": "path", "type": "string", "pattern": "^projects/[^/]+/locations/[^/]+/discoveredRanges/[^/]+$", "required": true, "description": "Required. The resource name of the DiscoveredRange to retrieve." } }, "response": { "$ref": "DiscoveredRange" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/discoveredRanges/{discoveredRangesId}", "path": "v1alpha/{+name}" }, "showUtilization": { "id": "cloudnumberregistry.projects.locations.discoveredRanges.showUtilization", "parameters": { "name": { "description": "Required. The resource name of the DiscoveredRange.", "pattern": "^projects/[^/]+/locations/[^/]+/discoveredRanges/[^/]+$", "required": true, "location": "path", "type": "string" } }, "response": { "$ref": "ShowDiscoveredRangeUtilizationResponse" }, "parameterOrder": [ "name" ], "httpMethod": "GET", "description": "Gets the details of a single DiscoveredRange and its utilization.", "path": "v1alpha/{+name}:showUtilization", "flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/discoveredRanges/{discoveredRangesId}:showUtilization", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] }, "findFreeIpRanges": { "path": "v1alpha/{+name}:findFreeIpRanges", "flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/discoveredRanges/{discoveredRangesId}:findFreeIpRanges", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "id": "cloudnumberregistry.projects.locations.discoveredRanges.findFreeIpRanges", "parameters": { "name": { "location": "path", "type": "string", "pattern": "^projects/[^/]+/locations/[^/]+/discoveredRanges/[^/]+$", "required": true, "description": "Required. The resource name of the DiscoveredRange to search within." }, "rangeCount": { "description": "Optional. The number of free IP ranges to find.", "location": "query", "type": "integer", "format": "int32" }, "cidrPrefixLength": { "format": "int32", "description": "Required. The prefix length of the free IP ranges to find.", "location": "query", "type": "integer" }, "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": "FindDiscoveredRangeFreeIpRangesResponse" }, "parameterOrder": [ "name" ], "httpMethod": "GET", "description": "Finds free IP ranges in a single DiscoveredRange." } } } } } } } }, "discoveryVersion": "v1", "name": "cloudnumberregistry", "icons": { "x16": "http://www.google.com/images/icons/product/search-16.gif", "x32": "http://www.google.com/images/icons/product/search-32.gif" }, "rootUrl": "https://cloudnumberregistry.googleapis.com/", "description": "", "canonicalName": "Cloud Number Registry", "schemas": { "CheckAvailabilityIpamAdminScopesResponse": { "description": "Response message for the CloudNumberRegistry.CheckAvailabilityIpamAdminScopes method.", "type": "object", "id": "CheckAvailabilityIpamAdminScopesResponse", "properties": { "scopeAvailabilities": { "description": "The details of the requested scopes.", "type": "array", "items": { "$ref": "IpamAdminScopeAvailability" } } } }, "OperationMetadata": { "description": "Represents the metadata of the long-running operation.", "type": "object", "id": "OperationMetadata", "properties": { "apiVersion": { "readOnly": true, "description": "Output only. API version used to start the operation.", "type": "string" }, "requestedCancellation": { "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`.", "type": "boolean", "readOnly": true }, "target": { "description": "Output only. Server-defined resource path for the target of the operation.", "type": "string", "readOnly": true }, "verb": { "readOnly": true, "description": "Output only. Name of the verb executed by the operation.", "type": "string" }, "endTime": { "description": "Output only. The time the operation finished running.", "type": "string", "readOnly": true, "format": "google-datetime" }, "createTime": { "description": "Output only. The time the operation was created.", "type": "string", "readOnly": true, "format": "google-datetime" }, "statusMessage": { "description": "Output only. Human-readable status of the operation, if any.", "type": "string", "readOnly": true } } }, "FindDiscoveredRangeFreeIpRangesResponse": { "id": "FindDiscoveredRangeFreeIpRangesResponse", "properties": { "freeIpCidrRanges": { "description": "Output only. The free IP CIDR ranges found.", "type": "array", "items": { "type": "string" }, "readOnly": true } }, "description": "Response message for the CloudNumberRegistry.FindDiscoveredRangeFreeIpRanges method.", "type": "object" }, "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", "id": "Empty", "properties": {} }, "ShowDiscoveredRangeUtilizationResponse": { "id": "ShowDiscoveredRangeUtilizationResponse", "properties": { "discoveredRange": { "$ref": "DiscoveredRange", "description": "The DiscoveredRange resource." }, "rangeUtilization": { "$ref": "RangeUtilization", "description": "The utilization details of the DiscoveredRange." } }, "description": "Response message for the CloudNumberRegistry.ShowDiscoveredRangeUtilization method.", "type": "object" }, "CustomRange": { "id": "CustomRange", "properties": { "name": { "description": "Required. Identifier. The resource name of the CustomRange, in the format `projects/{project}/locations/{location}/customRanges/{custom_range}`.", "type": "string" }, "ipv6CidrRange": { "description": "Optional. The IPv6 CIDR range of the CustomRange.", "type": "string" }, "registryBook": { "readOnly": true, "description": "Output only. The RegistryBook of the CustomRange. This field is inherited from the Realm or parent CustomRange depending on which one is specified.", "type": "string" }, "attributes": { "items": { "$ref": "Attribute" }, "description": "Optional. The attributes of the CustomRange.", "type": "array" }, "ipv4CidrRange": { "description": "Optional. The IPv4 CIDR range of the CustomRange.", "type": "string" }, "labels": { "additionalProperties": { "type": "string" }, "description": "Optional. User-defined labels.", "type": "object" }, "realm": { "description": "Optional. The resource name of the Realm associated with the CustomRange, in the format `projects/{project}/locations/{location}/realms/{realm}`. The Realm must be in the same project as the CustomRange. This field must not be set if the `parent_range` field is set, as the Realm will be inherited from the parent CustomRange.", "type": "string" }, "parentRange": { "description": "Optional. The resource name of the parent CustomRange, in the format `projects/{project}/locations/{location}/customRanges/{custom_range}`. If specified, the parent CustomRange must be in the same RegistryBook. This field is mutually exclusive with the `realm` field, as the Realm is inherited from the parent CustomRange.", "type": "string" }, "description": { "description": "Optional. The description of the CustomRange.", "type": "string" } }, "description": "A CustomRange represents a user-defined IP address range.", "type": "object" }, "Realm": { "id": "Realm", "properties": { "registryBook": { "description": "Required. Name of the RegistryBook that claims the Realm.", "type": "string" }, "updateTime": { "description": "Output only. The time at which the Realm was last updated.", "type": "string", "readOnly": true, "format": "google-datetime" }, "ipVersion": { "enumDescriptions": [ "Unspecified IP version.", "IPv4 IP version.", "IPv6 IP version." ], "description": "Optional. IP version of the Realm.", "type": "string", "enum": [ "IP_VERSION_UNSPECIFIED", "IPV4", "IPV6" ] }, "name": { "description": "Required. Identifier. The resource name of the Realm.", "type": "string" }, "aggregatedData": { "readOnly": true, "description": "Output only. Aggregated data for the Realm. Populated only when the view is AGGREGATE.", "$ref": "RealmAggregatedData" }, "createTime": { "description": "Output only. The time at which the Realm was created.", "type": "string", "readOnly": true, "format": "google-datetime" }, "trafficType": { "enumDescriptions": [ "Unspecified traffic type.", "Unset traffic type.", "Internet traffic.", "Private traffic.", "Linklocal traffic." ], "description": "Required. Traffic type of the Realm.", "type": "string", "enum": [ "TRAFFIC_TYPE_UNSPECIFIED", "UNSET", "INTERNET", "PRIVATE", "LINKLOCAL" ] }, "managementType": { "description": "Required. Management type of the Realm.", "type": "string", "enum": [ "MANAGEMENT_TYPE_UNSPECIFIED", "CNR", "USER" ], "enumDescriptions": [ "Unspecified management type.", "Managed by Cloud Number Registry.", "Managed by User." ] }, "discoveryMetadata": { "readOnly": true, "$ref": "DiscoveryMetadata", "description": "Output only. Discovery metadata of the Realm." }, "labels": { "additionalProperties": { "type": "string" }, "description": "Optional. User-defined labels.", "type": "object" } }, "description": "A Realm represents a distinct network domain or security zone. It groups Ranges that share the same traffic and management characteristics. All the ranges in a Realm are routable to each other, meaning that they cannot overlap.", "type": "object" }, "DiscoveryMetadata": { "id": "DiscoveryMetadata", "properties": { "createTime": { "description": "Output only. The time when the resource was created.", "type": "string", "readOnly": true, "format": "google-datetime" }, "state": { "type": "string", "enum": [ "RESOURCE_STATE_UNSPECIFIED", "INVALID", "EXISTS", "DOES_NOT_EXIST", "ERROR" ], "description": "Output only. The state of the resource.", "readOnly": true, "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." ] }, "updateTime": { "description": "Output only. The time when the resource was last modified.", "type": "string", "readOnly": true, "format": "google-datetime" }, "eventTime": { "description": "Output only. The time when the event happened.", "type": "string", "readOnly": true, "format": "google-datetime" }, "resourceUri": { "description": "Output only. The resource uri of the discovered resource.", "type": "string", "readOnly": true }, "sourceId": { "description": "Output only. The canonical google.aip.dev/122 name of the source resource.", "type": "string", "readOnly": true }, "resource": { "description": "Output only. The resource name of the discovered resource, should be API-agnostic. Example: \"projects/{project_number}/networks/{network_id}\".", "type": "string", "readOnly": true }, "sourceSubId": { "readOnly": true, "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\".", "type": "string" } }, "description": "Metadata about a discovered resource, tracking event times, state, and source information.", "type": "object" }, "ListCustomRangesResponse": { "description": "Response message for the CloudNumberRegistry.ListCustomRanges method.", "type": "object", "id": "ListCustomRangesResponse", "properties": { "customRanges": { "items": { "$ref": "CustomRange" }, "description": "The list of CustomRanges.", "type": "array" }, "nextPageToken": { "description": "A token to retrieve the next page of results, or empty if there are no more results in the list.", "type": "string" }, "unreachable": { "items": { "type": "string" }, "description": "Locations that could not be reached.", "type": "array" } } }, "Location": { "id": "Location", "properties": { "displayName": { "description": "The friendly name for this location, typically a nearby city name. For example, \"Tokyo\".", "type": "string" }, "locationId": { "description": "The canonical id for this location. For example: `\"us-east1\"`.", "type": "string" }, "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." } }, "name": { "description": "Resource name for the location, which may vary between implementations. For example: `\"projects/example-project/locations/us-east1\"`", "type": "string" }, "labels": { "description": "Cross-service attributes for the location. For example {\"cloud.googleapis.com/region\": \"us-east1\"}", "type": "object", "additionalProperties": { "type": "string" } } }, "description": "A resource that represents a Google Cloud location.", "type": "object" }, "SearchIpResourcesResult": { "description": "A result matching the search query, which can be either a Range or a Realm.", "type": "object", "id": "SearchIpResourcesResult", "properties": { "realm": { "$ref": "Realm", "description": "A Realm matching the search query." }, "range": { "description": "A Range matching the search query.", "$ref": "Range" } } }, "ListDiscoveredRangesResponse": { "description": "Response message for the CloudNumberRegistry.ListDiscoveredRanges method.", "type": "object", "id": "ListDiscoveredRangesResponse", "properties": { "nextPageToken": { "description": "A token to retrieve the next page of results, or empty if there are no more results in the list.", "type": "string" }, "unreachable": { "items": { "type": "string" }, "description": "Locations that could not be reached.", "type": "array" }, "discoveredRanges": { "items": { "$ref": "DiscoveredRange" }, "description": "The list of DiscoveredRanges.", "type": "array" } } }, "DisableIpamAdminScopeRequest": { "description": "Request message for the CloudNumberRegistry.DisableIpamAdminScope method.", "type": "object", "id": "DisableIpamAdminScopeRequest", "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" } } }, "ShowCustomRangeUtilizationResponse": { "description": "Response message for the CloudNumberRegistry.ShowCustomRangeUtilization method.", "type": "object", "id": "ShowCustomRangeUtilizationResponse", "properties": { "customRange": { "description": "The CustomRange resource.", "$ref": "CustomRange" }, "rangeUtilization": { "$ref": "RangeUtilization", "description": "The utilization details of the CustomRange." } } }, "AggregatedData": { "id": "AggregatedData", "properties": { "customRealmsCount": { "description": "Output only. Number of custom Realms in the RegistryBook.", "type": "integer", "readOnly": true, "format": "int32" }, "uniqueScopesCount": { "readOnly": true, "format": "int32", "description": "Output only. Number of scopes unique to the RegistryBook.", "type": "integer" }, "discoveredRangesCount": { "readOnly": true, "format": "int32", "description": "Output only. Number of DiscoveredRanges in the RegistryBook.", "type": "integer" }, "customRangesCount": { "description": "Output only. Number of CustomRanges in the RegistryBook.", "type": "integer", "readOnly": true, "format": "int32" }, "discoveredRealmsCount": { "readOnly": true, "format": "int32", "description": "Output only. Number of discovered Realms in the RegistryBook.", "type": "integer" } }, "description": "Aggregated data for the RegistryBook.", "type": "object" }, "DiscoveredRange": { "description": "A DiscoveredRange represents an IP address range automatically detected by the discovery pipeline.", "type": "object", "id": "DiscoveredRange", "properties": { "description": { "description": "Optional. Description of the DiscoveredRange.", "type": "string" }, "createTime": { "description": "Output only. The time at which the DiscoveredRange was created.", "type": "string", "readOnly": true, "format": "google-datetime" }, "labels": { "description": "Optional. User-defined labels.", "type": "object", "additionalProperties": { "type": "string" } }, "discoveryMetadata": { "readOnly": true, "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.", "$ref": "DiscoveryMetadata" }, "registryBook": { "readOnly": true, "description": "Output only. The RegistryBook of the DiscoveredRange.", "type": "string" }, "name": { "description": "Required. Identifier. The resource name of the DiscoveredRange, in the format `projects/{project}/locations/{location}/discoveredRanges/{discovered_range}`.", "type": "string" }, "ipv6CidrRange": { "description": "Optional. The IPv6 CIDR range of the DiscoveredRange.", "type": "string" }, "childCidrOverlapAllowed": { "description": "Output only. If true, allows child DiscoveredRanges of this DiscoveredRange to overlap with each other.", "type": "boolean", "readOnly": true }, "realm": { "description": "Optional. The Realm of the DiscoveredRange.", "type": "string" }, "parentRange": { "description": "Optional. The resource name of the parent DiscoveredRange, in the format `projects/{project}/locations/{location}/discoveredRanges/{discovered_range}`.", "type": "string" }, "ipv4CidrRange": { "description": "Optional. The IPv4 CIDR range of the DiscoveredRange.", "type": "string" }, "updateTime": { "description": "Output only. The time at which the DiscoveredRange was last updated.", "type": "string", "readOnly": true, "format": "google-datetime" }, "attributes": { "description": "Optional. The attributes of the DiscoveredRange.", "type": "array", "items": { "$ref": "Attribute" } } } }, "IpamAdminScopeAvailability": { "description": "Availability details for a specific IpamAdminScope.", "type": "object", "id": "IpamAdminScopeAvailability", "properties": { "adminProject": { "format": "int64", "description": "The admin project of the IpamAdminScope if it exists.", "type": "string" }, "availability": { "description": "The availability of the scope.", "type": "string", "enum": [ "AVAILABILITY_UNSPECIFIED", "AVAILABLE", "UNAVAILABLE" ], "enumDescriptions": [ "Unspecified availability.", "The scope is available.", "The scope is not available." ] }, "scope": { "description": "The scope of the IpamAdminScope.", "type": "string" } } }, "Operation": { "description": "This resource represents a long-running operation that is the result of a network API call.", "type": "object", "id": "Operation", "properties": { "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": { "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" }, "error": { "$ref": "Status", "description": "The error result of the operation in case of failure or cancellation." }, "metadata": { "additionalProperties": { "type": "any", "description": "Properties of the object. Contains field @type with type URL." }, "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" }, "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" } } }, "Attribute": { "description": "A key-value pair representing a custom attribute associated with a resource.", "type": "object", "id": "Attribute", "properties": { "key": { "description": "Required. The key of the attribute.", "type": "string" }, "value": { "description": "Required. The value of the attribute.", "type": "string" } } }, "Status": { "id": "Status", "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" } }, "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).", "type": "object" }, "SearchIpResourcesRequest": { "description": "Request message for the CloudNumberRegistry.SearchIpResources method.", "type": "object", "id": "SearchIpResourcesRequest", "properties": { "pageToken": { "description": "Optional. A token identifying a page of results the server should return.", "type": "string" }, "searchResourceTypes": { "items": { "enumDescriptions": [ "Unspecified search type.", "Search for Ranges.", "Search for Realms." ], "type": "string", "enum": [ "SEARCH_RESOURCE_TYPE_UNSPECIFIED", "RANGES", "REALMS" ] }, "description": "Optional. The type of resources to search for. If not specified, the server will return Ranges.", "type": "array" }, "query": { "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. - `management_type`: The management type of the Realm (e.g., \"CNR\", \"USER\"). 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` - `management_type=CNR`", "type": "string" }, "orderBy": { "description": "Optional. Hint for how to order the results. Supported sort fields are: - `name`: Sort alphabetically by the resource name. - `create_time`: Sort by the creation timestamp of the resource. - `update_time`: Sort by the last update timestamp of the resource. Supported directions are `asc` (ascending) and `desc` (descending). If unspecified, direction defaults to `asc`. Only sorting by a single field is supported.", "type": "string" }, "showUtilization": { "description": "Optional. Whether to show the utilization of the Ranges in the response.", "type": "boolean" }, "pageSize": { "format": "int32", "description": "Optional. Requested page size. Server may return fewer items than requested. If unspecified, server will pick an appropriate default.", "type": "integer" } } }, "FindCustomRangeFreeIpRangesResponse": { "id": "FindCustomRangeFreeIpRangesResponse", "properties": { "freeIpCidrRanges": { "items": { "type": "string" }, "readOnly": true, "description": "Output only. The free IP CIDR ranges found.", "type": "array" } }, "description": "Response message for the CloudNumberRegistry.FindCustomRangeFreeIpRanges method.", "type": "object" }, "SearchIpResourcesResponse": { "id": "SearchIpResourcesResponse", "properties": { "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": { "items": { "type": "string" }, "description": "Locations that could not be reached.", "type": "array" }, "ranges": { "description": "Deprecated: Use results field instead. The list of Ranges matching the search query.", "deprecated": true, "type": "array", "items": { "$ref": "Range" } } }, "description": "Response message for the CloudNumberRegistry.SearchIpResources method.", "type": "object" }, "RealmAggregatedData": { "id": "RealmAggregatedData", "properties": { "discoveredRangesCount": { "readOnly": true, "format": "int32", "description": "Output only. Number of DiscoveredRanges in the Realm.", "type": "integer" }, "customRangesCount": { "readOnly": true, "format": "int32", "description": "Output only. Number of CustomRanges in the Realm.", "type": "integer" } }, "description": "Aggregated data for the Realm.", "type": "object" }, "CleanupIpamAdminScopeRequest": { "description": "Request message for the CloudNumberRegistry.CleanupIpamAdminScope method.", "type": "object", "id": "CleanupIpamAdminScopeRequest", "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" } } }, "RegistryBook": { "id": "RegistryBook", "properties": { "updateTime": { "description": "Output only. The time at which the RegistryBook was last updated.", "type": "string", "readOnly": true, "format": "google-datetime" }, "aggregatedData": { "readOnly": true, "description": "Output only. Aggregated data for the RegistryBook. Populated only when the view is AGGREGATE.", "$ref": "AggregatedData" }, "createTime": { "readOnly": true, "format": "google-datetime", "description": "Output only. The time at which the RegistryBook was created.", "type": "string" }, "isDefault": { "readOnly": true, "description": "Output only. Whether the RegistryBook is the default one.", "type": "boolean" }, "claimedScopes": { "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.", "type": "array" }, "name": { "description": "Required. Identifier. The resource name of the RegistryBook.", "type": "string" }, "labels": { "additionalProperties": { "type": "string" }, "description": "Optional. User-defined labels.", "type": "object" } }, "description": "A RegistryBook organizes and manages IP address space. It claims specific scopes (such as projects) and groups related Realms and Ranges.", "type": "object" }, "ListIpamAdminScopesResponse": { "id": "ListIpamAdminScopesResponse", "properties": { "nextPageToken": { "description": "A token to retrieve the next page of results, or empty if there are no more results in the list.", "type": "string" }, "unreachable": { "items": { "type": "string" }, "description": "Locations that could not be reached.", "type": "array" }, "ipamAdminScopes": { "description": "The list of IpamAdminScopes.", "type": "array", "items": { "$ref": "IpamAdminScope" } } }, "description": "Response message for the CloudNumberRegistry.ListIpamAdminScopes method.", "type": "object" }, "ListOperationsResponse": { "id": "ListOperationsResponse", "properties": { "nextPageToken": { "description": "The standard List next-page token.", "type": "string" }, "unreachable": { "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", "items": { "type": "string" } }, "operations": { "items": { "$ref": "Operation" }, "description": "A list of operations that matches the specified filter in the request.", "type": "array" } }, "description": "The response message for Operations.ListOperations.", "type": "object" }, "RangeUtilization": { "description": "Utilization metrics for an IP Range, including consumed and produced address counts.", "type": "object", "id": "RangeUtilization", "properties": { "usage": { "readOnly": true, "format": "double", "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.", "type": "number" }, "totalConsumed": { "readOnly": true, "description": "Output only. The total number of IP addresses consumed in the Range.", "type": "string" }, "totalProduced": { "description": "Output only. The total number of IP addresses produced in the Range.", "type": "string", "readOnly": true } } }, "ListRealmsResponse": { "description": "Response message for the CloudNumberRegistry.ListRealms method.", "type": "object", "id": "ListRealmsResponse", "properties": { "realms": { "description": "The list of Realms.", "type": "array", "items": { "$ref": "Realm" } }, "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" } } } }, "CancelOperationRequest": { "description": "The request message for Operations.CancelOperation.", "type": "object", "id": "CancelOperationRequest", "properties": {} }, "ListRegistryBooksResponse": { "description": "Response message for the CloudNumberRegistry.ListRegistryBooks method.", "type": "object", "id": "ListRegistryBooksResponse", "properties": { "registryBooks": { "items": { "$ref": "RegistryBook" }, "description": "The list of RegistryBook", "type": "array" }, "nextPageToken": { "description": "A token identifying a page of results the server should return.", "type": "string" }, "unreachable": { "items": { "type": "string" }, "description": "Locations that could not be reached.", "type": "array" } } }, "IpamAdminScope": { "description": "An IpamAdminScope defines the administrative boundary for IP address discovery and management. It configures which platforms and organizational scopes are enabled for IP tracking.", "type": "object", "id": "IpamAdminScope", "properties": { "updateTime": { "description": "Output only. The time at which the IpamAdminScope was last updated.", "type": "string", "readOnly": true, "format": "google-datetime" }, "scopes": { "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.", "type": "array", "items": { "type": "string" } }, "enabledAddonPlatforms": { "items": { "enumDescriptions": [ "Unspecified add-on platform.", "Google Compute Engine.", "Deprecated: Use COMPUTE_ENGINE instead." ], "type": "string", "enumDeprecated": [ false, false, true ], "enum": [ "ADD_ON_PLATFORM_UNSPECIFIED", "COMPUTE_ENGINE", "GCE" ] }, "description": "Required. Add-on platforms that are enabled for this IpamAdminScope. Cloud Number Registry only discovers the IP addresses from the enabled platforms.", "type": "array" }, "state": { "type": "string", "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, "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." ], "description": "Output only. State of resource discovery pipeline." }, "createTime": { "readOnly": true, "format": "google-datetime", "description": "Output only. The time at which the IpamAdminScope was created.", "type": "string" }, "name": { "description": "Required. Identifier. The resource name of the IpamAdminScope.", "type": "string" }, "labels": { "additionalProperties": { "type": "string" }, "description": "Optional. User-defined labels.", "type": "object" } } }, "ListLocationsResponse": { "id": "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" } }, "description": "The response message for Locations.ListLocations.", "type": "object" }, "Range": { "description": "Represents either a CustomRange or a DiscoveredRange.", "type": "object", "id": "Range", "properties": { "customRange": { "description": "A CustomRange.", "$ref": "CustomRange" }, "discoveredRange": { "$ref": "DiscoveredRange", "description": "A DiscoveredRange." }, "utilization": { "description": "The utilization of the Range.", "$ref": "RangeUtilization" } } } }, "parameters": { "upload_protocol": { "type": "string", "description": "Upload protocol for media (e.g. \"raw\", \"multipart\").", "location": "query" }, "fields": { "type": "string", "description": "Selector specifying which fields to include in a partial response.", "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": { "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.", "location": "query" }, "alt": { "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", "type": "string", "enum": [ "json", "media", "proto" ], "location": "query" }, "callback": { "type": "string", "description": "JSONP", "location": "query" }, "$.xgafv": { "type": "string", "enum": [ "1", "2" ], "location": "query", "enumDescriptions": [ "v1 error format", "v2 error format" ], "description": "V1 error format." }, "access_token": { "type": "string", "description": "OAuth access token.", "location": "query" }, "oauth_token": { "type": "string", "description": "OAuth 2.0 token for the current user.", "location": "query" }, "prettyPrint": { "type": "boolean", "description": "Returns response with indentations and line breaks.", "default": "true", "location": "query" }, "uploadType": { "type": "string", "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\").", "location": "query" } } }