# Cloud Number Registry API . projects . locations . realms

## Instance Methods

Close httplib2 connections.

Creates a new Realm in a given project and location.

Deletes a single Realm.

Gets details of a single Realm.

Lists Realms in a given project and location.

Retrieves the next page of results.

Updates the parameters of a single Realm.

### Method Details

`close()`

    Close httplib2 connections.

`create(parent, body=None, realmId=None, requestId=None, x__xgafv=None)`

    Creates a new Realm in a given project and location.

    Args:
      parent: string, Required. The parent resource name where the Realm will be created. (required)
      body: object, The request body.
        The object takes the form of:

    { # 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.
      "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", # Optional. 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.
    }

      realmId: string, Required. The ID to use for the Realm, 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.
      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 Realm.

    Args:
      name: string, Required. The resource name of the Realm 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.
      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 Realm.

    Args:
      name: string, Required. The resource name of the Realm to retrieve. (required)
      view: string, Optional. The view of the Realm to retrieve.
        Allowed values
          REALM_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 Realm.
      x__xgafv: string, V1 error format.
        Allowed values
          1 - v1 error format
          2 - v2 error format

    Returns:
      An object of the form:

        { # 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.
      "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", # Optional. 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.
    }

`list(parent, filter=None, orderBy=None, pageSize=None, pageToken=None, view=None, x__xgafv=None)`

    Lists Realms 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 Realm to retrieve.
        Allowed values
          REALM_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 Realm.
      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.ListRealms method.
      "nextPageToken": "A String", # A token identifying a page of results the server should return.
      "realms": [ # The list of Realms.
        { # 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.
          "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", # Optional. 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",
      ],
    }

`list_next(previous_request, previous_response)`

    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 Realm.

    Args:
      name: string, Required. Identifier. The resource name of the Realm. (required)
      body: object, The request body.
        The object takes the form of:

    { # 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.
      "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", # Optional. 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.
    }

      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.
      updateMask: string, Optional. Field mask is used to specify the fields to be overwritten in the Realm resource by the update.
      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.
      },
    }