Cloud Number Registry API (cloudnumberregistry:v1alpha)

2026-08-23

8 new methods

Additions

    Methods
  • cloudnumberregistry.organizations.locations.orgNumberRegistries.list

      Flat Path : v1alpha/organizations/{organizationsId}/locations/{locationsId}/orgNumberRegistries

      HTTP Method : GET

      Path : v1alpha/{+parent}/orgNumberRegistries

      Parameters :

        parent

          Location : path

          Required : Yes

          Description : Required. The parent resource name, for example `organizations/*/locations/*`.

          Type : string

          Pattern : ^organizations/[^/]+/locations/[^/]+$

        pageToken

          Type : string

          Description : Optional. A token identifying a page of results the server should return.

          Location : query

        pageSize

          Type : integer

          Description : Optional. Requested page size. Server may return fewer items than requested. If unspecified, server will pick an appropriate default.

          Location : query

          Format : int32

        filter

          Description : Optional. Filter expression to filter the results.

          Location : query

          Type : string

        orderBy

          Description : Optional. Hint for how to order the results.

          Location : query

          Type : string

      Parameter Order : parent

      Scopes : https://www.googleapis.com/auth/cloud-platform

      Description : Lists OrgNumberRegistries in a given organization and location.

  • cloudnumberregistry.organizations.locations.orgNumberRegistries.get

      Parameters :

        name

          Pattern : ^organizations/[^/]+/locations/[^/]+/orgNumberRegistries/[^/]+$

          Type : string

          Description : Required. The resource name of the OrgNumberRegistry to retrieve.

          Required : Yes

          Location : path

      Flat Path : v1alpha/organizations/{organizationsId}/locations/{locationsId}/orgNumberRegistries/{orgNumberRegistriesId}

      HTTP Method : GET

      Path : v1alpha/{+name}

      Parameter Order : name

      Scopes : https://www.googleapis.com/auth/cloud-platform

      Description : Gets details of a single OrgNumberRegistry.

  • cloudnumberregistry.organizations.locations.orgNumberRegistries.delete

      Parameter Order : name

      Scopes : https://www.googleapis.com/auth/cloud-platform

      Description : Deletes a single OrgNumberRegistry.

      Flat Path : v1alpha/organizations/{organizationsId}/locations/{locationsId}/orgNumberRegistries/{orgNumberRegistriesId}

      HTTP Method : DELETE

      Path : v1alpha/{+name}

      Parameters :

        name

          Location : path

          Required : Yes

          Type : string

          Description : Required. The resource name of the OrgNumberRegistry to delete.

          Pattern : ^organizations/[^/]+/locations/[^/]+/orgNumberRegistries/[^/]+$

        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

  • cloudnumberregistry.organizations.locations.orgNumberRegistries.create

      HTTP Method : POST

      Path : v1alpha/{+parent}/orgNumberRegistries

      Flat Path : v1alpha/organizations/{organizationsId}/locations/{locationsId}/orgNumberRegistries

      Parameters :

        orgNumberRegistryId

          Description : Required. The ID to use for the OrgNumberRegistry, which will become the final segment of the resource name.

          Location : query

          Type : string

        parent

          Pattern : ^organizations/[^/]+/locations/[^/]+$

          Type : string

          Description : Required. The parent resource name where the OrgNumberRegistry will be created.

          Required : Yes

          Location : path

        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

      Parameter Order : parent

      Scopes : https://www.googleapis.com/auth/cloud-platform

      Description : Creates a new OrgNumberRegistry in a given organization and location.

  • cloudnumberregistry.organizations.locations.operations.cancel

      Parameter Order : name

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

      HTTP Method : POST

      Path : v1alpha/{+name}:cancel

      Flat Path : v1alpha/organizations/{organizationsId}/locations/{locationsId}/operations/{operationsId}:cancel

      Parameters :

        name

          Location : path

          Required : Yes

          Description : The name of the operation resource to be cancelled.

          Type : string

          Pattern : ^organizations/[^/]+/locations/[^/]+/operations/[^/]+$

  • cloudnumberregistry.organizations.locations.operations.list

      Flat Path : v1alpha/organizations/{organizationsId}/locations/{locationsId}/operations

      Path : v1alpha/{+name}/operations

      HTTP Method : GET

      Parameters :

        filter

          Type : string

          Description : The standard list filter.

          Location : query

        pageSize

          Description : The standard list page size.

          Location : query

          Format : int32

          Type : integer

        returnPartialSuccess

          Description : When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the ListOperationsResponse.unreachable field. This can only be `true` when reading across collections. For example, when `parent` is set to `"projects/example/locations/-"`. This field is not supported by default and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.

          Location : query

          Type : boolean

        name

          Required : Yes

          Location : path

          Pattern : ^organizations/[^/]+/locations/[^/]+$

          Description : The name of the operation's parent resource.

          Type : string

        pageToken

          Description : The standard list page token.

          Location : query

          Type : string

      Parameter Order : name

      Scopes : https://www.googleapis.com/auth/cloud-platform

      Description : Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.

  • cloudnumberregistry.organizations.locations.operations.get

      Flat Path : v1alpha/organizations/{organizationsId}/locations/{locationsId}/operations/{operationsId}

      Path : v1alpha/{+name}

      HTTP Method : GET

      Parameters :

        name

          Required : Yes

          Location : path

          Pattern : ^organizations/[^/]+/locations/[^/]+/operations/[^/]+$

          Description : The name of the operation resource.

          Type : string

      Parameter Order : name

      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.

  • cloudnumberregistry.organizations.locations.operations.delete

      Parameter Order : name

      Scopes : https://www.googleapis.com/auth/cloud-platform

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

      Parameters :

        name

          Required : Yes

          Location : path

          Pattern : ^organizations/[^/]+/locations/[^/]+/operations/[^/]+$

          Type : string

          Description : The name of the operation resource to be deleted.

      HTTP Method : DELETE

      Path : v1alpha/{+name}

      Flat Path : v1alpha/organizations/{organizationsId}/locations/{locationsId}/operations/{operationsId}