Close httplib2 connections.
create(parent, body=None, registryBookId=None, requestId=None, x__xgafv=None)
Creates a new RegistryBook in a given project and location.
delete(name, force=None, requestId=None, x__xgafv=None)
Deletes a single RegistryBook.
get(name, view=None, x__xgafv=None)
Gets details of a single RegistryBook.
list(parent, filter=None, orderBy=None, pageSize=None, pageToken=None, view=None, x__xgafv=None)
Lists RegistryBooks in a given project and location.
Retrieves the next page of results.
patch(name, body=None, requestId=None, updateMask=None, x__xgafv=None)
Updates the parameters of a single RegistryBook.
searchIpResources(name, body=None, x__xgafv=None)
Searches IP resources in a given RegistryBook.
Retrieves the next page of results.
close()
Close httplib2 connections.
create(parent, body=None, registryBookId=None, requestId=None, x__xgafv=None)
Creates a new RegistryBook in a given project and location.
Args:
parent: string, Required. The parent resource name where the RegistryBook will be created. (required)
body: object, The request body.
The object takes the form of:
{ # A RegistryBook organizes and manages IP address space. It claims specific scopes (such as projects) and groups related Realms and Ranges.
"aggregatedData": { # Aggregated data for the RegistryBook. # Output only. Aggregated data for the RegistryBook. Populated only when the view is AGGREGATE.
"customRangesCount": 42, # Output only. Number of CustomRanges in the RegistryBook.
"customRealmsCount": 42, # Output only. Number of custom Realms in the RegistryBook.
"discoveredRangesCount": 42, # Output only. Number of DiscoveredRanges in the RegistryBook.
"discoveredRealmsCount": 42, # Output only. Number of discovered Realms in the RegistryBook.
"uniqueScopesCount": 42, # Output only. Number of scopes unique to the RegistryBook.
},
"claimedScopes": [ # 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.
"A String",
],
"createTime": "A String", # Output only. The time at which the RegistryBook was created.
"isDefault": True or False, # Output only. Whether the RegistryBook is the default one.
"labels": { # Optional. User-defined labels.
"a_key": "A String",
},
"name": "A String", # Required. Identifier. The resource name of the RegistryBook.
"updateTime": "A String", # Output only. The time at which the RegistryBook was last updated.
}
registryBookId: string, Required. The ID to use for the RegistryBook, which will become the final segment of the resource name.
requestId: string, 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).
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # This resource represents a long-running operation that is the result of a network API call.
"done": True or False, # 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.
"error": { # 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). # The error result of the operation in case of failure or cancellation.
"code": 42, # The status code, which should be an enum value of google.rpc.Code.
"details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
{
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
],
"message": "A String", # 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.
},
"metadata": { # 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.
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
"name": "A String", # 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}`.
"response": { # 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`.
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
}
delete(name, force=None, requestId=None, x__xgafv=None)
Deletes a single RegistryBook.
Args:
name: string, Required. The resource name of the RegistryBook to delete. (required)
force: boolean, Optional. If set to true, all associated resources will be deleted.
requestId: string, 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).
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # This resource represents a long-running operation that is the result of a network API call.
"done": True or False, # 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.
"error": { # 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). # The error result of the operation in case of failure or cancellation.
"code": 42, # The status code, which should be an enum value of google.rpc.Code.
"details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
{
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
],
"message": "A String", # 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.
},
"metadata": { # 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.
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
"name": "A String", # 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}`.
"response": { # 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`.
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
}
get(name, view=None, x__xgafv=None)
Gets details of a single RegistryBook.
Args:
name: string, Required. The resource name of the RegistryBook to retrieve. (required)
view: string, Optional. The view of the RegistryBook to retrieve.
Allowed values
REGISTRY_BOOK_VIEW_UNSPECIFIED - Unspecified view. Defaults to BASIC.
BASIC - Basic view.
FULL - Full view. Includes the same data as the BASIC view.
AGGREGATE - Aggregate includes data about the child resources of the RegistryBook.
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # A RegistryBook organizes and manages IP address space. It claims specific scopes (such as projects) and groups related Realms and Ranges.
"aggregatedData": { # Aggregated data for the RegistryBook. # Output only. Aggregated data for the RegistryBook. Populated only when the view is AGGREGATE.
"customRangesCount": 42, # Output only. Number of CustomRanges in the RegistryBook.
"customRealmsCount": 42, # Output only. Number of custom Realms in the RegistryBook.
"discoveredRangesCount": 42, # Output only. Number of DiscoveredRanges in the RegistryBook.
"discoveredRealmsCount": 42, # Output only. Number of discovered Realms in the RegistryBook.
"uniqueScopesCount": 42, # Output only. Number of scopes unique to the RegistryBook.
},
"claimedScopes": [ # 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.
"A String",
],
"createTime": "A String", # Output only. The time at which the RegistryBook was created.
"isDefault": True or False, # Output only. Whether the RegistryBook is the default one.
"labels": { # Optional. User-defined labels.
"a_key": "A String",
},
"name": "A String", # Required. Identifier. The resource name of the RegistryBook.
"updateTime": "A String", # Output only. The time at which the RegistryBook was last updated.
}
list(parent, filter=None, orderBy=None, pageSize=None, pageToken=None, view=None, x__xgafv=None)
Lists RegistryBooks in a given project and location.
Args:
parent: string, Required. The parent resource name, for example `projects/*/locations/*`. (required)
filter: string, Optional. Filter expression to filter the results.
orderBy: string, Optional. Hint for how to order the results.
pageSize: integer, Optional. Requested page size. Server may return fewer items than requested. If unspecified, server will pick an appropriate default.
pageToken: string, Optional. A token identifying a page of results the server should return.
view: string, Optional. The view of the RegistryBook to retrieve.
Allowed values
REGISTRY_BOOK_VIEW_UNSPECIFIED - Unspecified view. Defaults to BASIC.
BASIC - Basic view.
FULL - Full view. Includes the same data as the BASIC view.
AGGREGATE - Aggregate includes data about the child resources of the RegistryBook.
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # Response message for the CloudNumberRegistry.ListRegistryBooks method.
"nextPageToken": "A String", # A token identifying a page of results the server should return.
"registryBooks": [ # The list of RegistryBook
{ # A RegistryBook organizes and manages IP address space. It claims specific scopes (such as projects) and groups related Realms and Ranges.
"aggregatedData": { # Aggregated data for the RegistryBook. # Output only. Aggregated data for the RegistryBook. Populated only when the view is AGGREGATE.
"customRangesCount": 42, # Output only. Number of CustomRanges in the RegistryBook.
"customRealmsCount": 42, # Output only. Number of custom Realms in the RegistryBook.
"discoveredRangesCount": 42, # Output only. Number of DiscoveredRanges in the RegistryBook.
"discoveredRealmsCount": 42, # Output only. Number of discovered Realms in the RegistryBook.
"uniqueScopesCount": 42, # Output only. Number of scopes unique to the RegistryBook.
},
"claimedScopes": [ # 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.
"A String",
],
"createTime": "A String", # Output only. The time at which the RegistryBook was created.
"isDefault": True or False, # Output only. Whether the RegistryBook is the default one.
"labels": { # Optional. User-defined labels.
"a_key": "A String",
},
"name": "A String", # Required. Identifier. The resource name of the RegistryBook.
"updateTime": "A String", # Output only. The time at which the RegistryBook was last updated.
},
],
"unreachable": [ # Locations that could not be reached.
"A String",
],
}
list_next()
Retrieves the next page of results.
Args:
previous_request: The request for the previous page. (required)
previous_response: The response from the request for the previous page. (required)
Returns:
A request object that you can call 'execute()' on to request the next
page. Returns None if there are no more items in the collection.
patch(name, body=None, requestId=None, updateMask=None, x__xgafv=None)
Updates the parameters of a single RegistryBook.
Args:
name: string, Required. Identifier. The resource name of the RegistryBook. (required)
body: object, The request body.
The object takes the form of:
{ # A RegistryBook organizes and manages IP address space. It claims specific scopes (such as projects) and groups related Realms and Ranges.
"aggregatedData": { # Aggregated data for the RegistryBook. # Output only. Aggregated data for the RegistryBook. Populated only when the view is AGGREGATE.
"customRangesCount": 42, # Output only. Number of CustomRanges in the RegistryBook.
"customRealmsCount": 42, # Output only. Number of custom Realms in the RegistryBook.
"discoveredRangesCount": 42, # Output only. Number of DiscoveredRanges in the RegistryBook.
"discoveredRealmsCount": 42, # Output only. Number of discovered Realms in the RegistryBook.
"uniqueScopesCount": 42, # Output only. Number of scopes unique to the RegistryBook.
},
"claimedScopes": [ # 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.
"A String",
],
"createTime": "A String", # Output only. The time at which the RegistryBook was created.
"isDefault": True or False, # Output only. Whether the RegistryBook is the default one.
"labels": { # Optional. User-defined labels.
"a_key": "A String",
},
"name": "A String", # Required. Identifier. The resource name of the RegistryBook.
"updateTime": "A String", # Output only. The time at which the RegistryBook was last updated.
}
requestId: string, 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).
updateMask: string, 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.
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # This resource represents a long-running operation that is the result of a network API call.
"done": True or False, # 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.
"error": { # 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). # The error result of the operation in case of failure or cancellation.
"code": 42, # The status code, which should be an enum value of google.rpc.Code.
"details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
{
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
],
"message": "A String", # 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.
},
"metadata": { # 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.
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
"name": "A String", # 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}`.
"response": { # 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`.
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
}
searchIpResources(name, body=None, x__xgafv=None)
Searches IP resources in a given RegistryBook.
Args:
name: string, Required. The resource name of the RegistryBook to search in. (required)
body: object, The request body.
The object takes the form of:
{ # Request message for the CloudNumberRegistry.SearchIpResources method.
"orderBy": "A String", # 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.
"pageSize": 42, # Optional. Requested page size. Server may return fewer items than requested. If unspecified, server will pick an appropriate default.
"pageToken": "A String", # Optional. A token identifying a page of results the server should return.
"query": "A String", # Optional. Search query. This string filters resources in an AIP-160-like format. It has some limitations. You can only specify top level conjunctions or attribute level negations. Each restriction can only be used once except the attribute restriction. The available restrictions for Ranges are: - `realm`: The Realm name to search in. - `ip_address`: The IP address to search for within Ranges. - `ip_version`: The IP version to filter by (e.g., "IPV4", "IPV6"). - `parent_range`: The parent Range of the Range to search for. - `attribute_text`: The attribute text to search for within Ranges. - `attribute`: The attribute key and value to filter by. The available restrictions for Realms are: - `ip_version`: The IP version to search for. - `management_type`: The management type of the Realm (e.g., "CNR", "USER"). Only one of attribute_text or multiple attribute filters can be specified. Examples: - `realm=test-realm` - `realm=test-realm AND ip_address=10.0.0.0` - `realm=test-realm AND ip_version=IPV6` - `realm=test-realm AND attribute_text=test` - `ip_address=10.0.0.0 AND attribute:(key1=value1) AND attribute:(key2=value2)` - `attribute_text=test AND parent_range=projects/123/locations/global/discoveredRanges/test-parent-range` - `management_type=CNR`
"searchResourceTypes": [ # Optional. The type of resources to search for. If not specified, the server will return Ranges.
"A String",
],
"showUtilization": True or False, # Optional. Whether to show the utilization of the Ranges in the response.
}
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # Response message for the CloudNumberRegistry.SearchIpResources method.
"nextPageToken": "A String", # A token identifying a page of results the server should return.
"ranges": [ # Deprecated: Use results field instead. The list of Ranges matching the search query.
{ # Represents either a CustomRange or a DiscoveredRange.
"customRange": { # A CustomRange represents a user-defined IP address range. # A CustomRange.
"attributes": [ # Optional. The attributes of the CustomRange.
{ # A key-value pair representing a custom attribute associated with a resource.
"key": "A String", # Required. The key of the attribute.
"value": "A String", # Required. The value of the attribute.
},
],
"description": "A String", # Optional. The description of the CustomRange.
"ipv4CidrRange": "A String", # Optional. The IPv4 CIDR range of the CustomRange.
"ipv6CidrRange": "A String", # Optional. The IPv6 CIDR range of the CustomRange.
"labels": { # Optional. User-defined labels.
"a_key": "A String",
},
"name": "A String", # Required. Identifier. The resource name of the CustomRange, in the format `projects/{project}/locations/{location}/customRanges/{custom_range}`.
"parentRange": "A String", # 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.
"realm": "A String", # 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.
"registryBook": "A String", # Output only. The RegistryBook of the CustomRange. This field is inherited from the Realm or parent CustomRange depending on which one is specified.
},
"discoveredRange": { # A DiscoveredRange represents an IP address range automatically detected by the discovery pipeline. # A DiscoveredRange.
"attributes": [ # Optional. The attributes of the DiscoveredRange.
{ # A key-value pair representing a custom attribute associated with a resource.
"key": "A String", # Required. The key of the attribute.
"value": "A String", # Required. The value of the attribute.
},
],
"childCidrOverlapAllowed": True or False, # Output only. If true, allows child DiscoveredRanges of this DiscoveredRange to overlap with each other.
"createTime": "A String", # Output only. The time at which the DiscoveredRange was created.
"description": "A String", # Optional. Description of the DiscoveredRange.
"discoveryMetadata": { # Metadata about a discovered resource, tracking event times, state, and source information. # 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.
"createTime": "A String", # Output only. The time when the resource was created.
"eventTime": "A String", # Output only. The time when the event happened.
"resource": "A String", # Output only. The resource name of the discovered resource, should be API-agnostic. Example: "projects/{project_number}/networks/{network_id}".
"resourceUri": "A String", # Output only. The resource uri of the discovered resource.
"sourceId": "A String", # Output only. The canonical google.aip.dev/122 name of the source resource.
"sourceSubId": "A String", # 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".
"state": "A String", # Output only. The state of the resource.
"updateTime": "A String", # Output only. The time when the resource was last modified.
},
"ipv4CidrRange": "A String", # Optional. The IPv4 CIDR range of the DiscoveredRange.
"ipv6CidrRange": "A String", # Optional. The IPv6 CIDR range of the DiscoveredRange.
"labels": { # Optional. User-defined labels.
"a_key": "A String",
},
"name": "A String", # Required. Identifier. The resource name of the DiscoveredRange, in the format `projects/{project}/locations/{location}/discoveredRanges/{discovered_range}`.
"parentRange": "A String", # Optional. The resource name of the parent DiscoveredRange, in the format `projects/{project}/locations/{location}/discoveredRanges/{discovered_range}`.
"realm": "A String", # Optional. The Realm of the DiscoveredRange.
"registryBook": "A String", # Output only. The RegistryBook of the DiscoveredRange.
"updateTime": "A String", # Output only. The time at which the DiscoveredRange was last updated.
},
"utilization": { # Utilization metrics for an IP Range, including consumed and produced address counts. # The utilization of the Range.
"totalConsumed": "A String", # Output only. The total number of IP addresses consumed in the Range.
"totalProduced": "A String", # Output only. The total number of IP addresses produced in the Range.
"usage": 3.14, # 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.
},
},
],
"results": [ # The list of results matching the search query.
{ # A result matching the search query, which can be either a Range or a Realm.
"range": { # Represents either a CustomRange or a DiscoveredRange. # A Range matching the search query.
"customRange": { # A CustomRange represents a user-defined IP address range. # A CustomRange.
"attributes": [ # Optional. The attributes of the CustomRange.
{ # A key-value pair representing a custom attribute associated with a resource.
"key": "A String", # Required. The key of the attribute.
"value": "A String", # Required. The value of the attribute.
},
],
"description": "A String", # Optional. The description of the CustomRange.
"ipv4CidrRange": "A String", # Optional. The IPv4 CIDR range of the CustomRange.
"ipv6CidrRange": "A String", # Optional. The IPv6 CIDR range of the CustomRange.
"labels": { # Optional. User-defined labels.
"a_key": "A String",
},
"name": "A String", # Required. Identifier. The resource name of the CustomRange, in the format `projects/{project}/locations/{location}/customRanges/{custom_range}`.
"parentRange": "A String", # 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.
"realm": "A String", # 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.
"registryBook": "A String", # Output only. The RegistryBook of the CustomRange. This field is inherited from the Realm or parent CustomRange depending on which one is specified.
},
"discoveredRange": { # A DiscoveredRange represents an IP address range automatically detected by the discovery pipeline. # A DiscoveredRange.
"attributes": [ # Optional. The attributes of the DiscoveredRange.
{ # A key-value pair representing a custom attribute associated with a resource.
"key": "A String", # Required. The key of the attribute.
"value": "A String", # Required. The value of the attribute.
},
],
"childCidrOverlapAllowed": True or False, # Output only. If true, allows child DiscoveredRanges of this DiscoveredRange to overlap with each other.
"createTime": "A String", # Output only. The time at which the DiscoveredRange was created.
"description": "A String", # Optional. Description of the DiscoveredRange.
"discoveryMetadata": { # Metadata about a discovered resource, tracking event times, state, and source information. # 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.
"createTime": "A String", # Output only. The time when the resource was created.
"eventTime": "A String", # Output only. The time when the event happened.
"resource": "A String", # Output only. The resource name of the discovered resource, should be API-agnostic. Example: "projects/{project_number}/networks/{network_id}".
"resourceUri": "A String", # Output only. The resource uri of the discovered resource.
"sourceId": "A String", # Output only. The canonical google.aip.dev/122 name of the source resource.
"sourceSubId": "A String", # 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".
"state": "A String", # Output only. The state of the resource.
"updateTime": "A String", # Output only. The time when the resource was last modified.
},
"ipv4CidrRange": "A String", # Optional. The IPv4 CIDR range of the DiscoveredRange.
"ipv6CidrRange": "A String", # Optional. The IPv6 CIDR range of the DiscoveredRange.
"labels": { # Optional. User-defined labels.
"a_key": "A String",
},
"name": "A String", # Required. Identifier. The resource name of the DiscoveredRange, in the format `projects/{project}/locations/{location}/discoveredRanges/{discovered_range}`.
"parentRange": "A String", # Optional. The resource name of the parent DiscoveredRange, in the format `projects/{project}/locations/{location}/discoveredRanges/{discovered_range}`.
"realm": "A String", # Optional. The Realm of the DiscoveredRange.
"registryBook": "A String", # Output only. The RegistryBook of the DiscoveredRange.
"updateTime": "A String", # Output only. The time at which the DiscoveredRange was last updated.
},
"utilization": { # Utilization metrics for an IP Range, including consumed and produced address counts. # The utilization of the Range.
"totalConsumed": "A String", # Output only. The total number of IP addresses consumed in the Range.
"totalProduced": "A String", # Output only. The total number of IP addresses produced in the Range.
"usage": 3.14, # 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.
},
},
"realm": { # 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. # A Realm matching the search query.
"aggregatedData": { # Aggregated data for the Realm. # Output only. Aggregated data for the Realm. Populated only when the view is AGGREGATE.
"customRangesCount": 42, # Output only. Number of CustomRanges in the Realm.
"discoveredRangesCount": 42, # Output only. Number of DiscoveredRanges in the Realm.
},
"createTime": "A String", # Output only. The time at which the Realm was created.
"discoveryMetadata": { # Metadata about a discovered resource, tracking event times, state, and source information. # Output only. Discovery metadata of the Realm.
"createTime": "A String", # Output only. The time when the resource was created.
"eventTime": "A String", # Output only. The time when the event happened.
"resource": "A String", # Output only. The resource name of the discovered resource, should be API-agnostic. Example: "projects/{project_number}/networks/{network_id}".
"resourceUri": "A String", # Output only. The resource uri of the discovered resource.
"sourceId": "A String", # Output only. The canonical google.aip.dev/122 name of the source resource.
"sourceSubId": "A String", # 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".
"state": "A String", # Output only. The state of the resource.
"updateTime": "A String", # Output only. The time when the resource was last modified.
},
"ipVersion": "A String", # Optional. IP version of the Realm.
"labels": { # Optional. User-defined labels.
"a_key": "A String",
},
"managementType": "A String", # Required. Management type of the Realm.
"name": "A String", # Required. Identifier. The resource name of the Realm.
"registryBook": "A String", # Required. Name of the RegistryBook that claims the Realm.
"trafficType": "A String", # Required. Traffic type of the Realm.
"updateTime": "A String", # Output only. The time at which the Realm was last updated.
},
},
],
"unreachable": [ # Locations that could not be reached.
"A String",
],
}
searchIpResources_next()
Retrieves the next page of results.
Args:
previous_request: The request for the previous page. (required)
previous_response: The response from the request for the previous page. (required)
Returns:
A request object that you can call 'execute()' on to request the next
page. Returns None if there are no more items in the collection.