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