realms

Creates, updates, deletes, gets or lists a realms resource.

Overview

Name	realms
Type	Resource
Id	google.cloudnumberregistry.realms

Fields

The following fields are returned by SELECT queries:

get

Name	Datatype	Description
name	string	Required. Identifier. The resource name of the Realm.
aggregatedData	object	Output only. Aggregated data for the Realm. Populated only when the view is AGGREGATE. (id: RealmAggregatedData)
createTime	string (google-datetime)	Output only. The time at which the Realm was created.
discoveryMetadata	object	Output only. Discovery metadata of the Realm. (id: DiscoveryMetadata)
ipVersion	string	Optional. IP version of the Realm. (IP_VERSION_UNSPECIFIED, IPV4, IPV6)
labels	object	Optional. User-defined labels.
managementType	string	Optional. Management type of the Realm. (MANAGEMENT_TYPE_UNSPECIFIED, CNR, USER)
registryBook	string	Required. Name of the RegistryBook that claims the Realm.
trafficType	string	Required. Traffic type of the Realm. (TRAFFIC_TYPE_UNSPECIFIED, UNSET, INTERNET, PRIVATE, LINKLOCAL)
updateTime	string (google-datetime)	Output only. The time at which the Realm was last updated.

list

Name	Datatype	Description

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	projectsId, locationsId, realmsId	view	Gets details of a single Realm.
list	select	projectsId, locationsId	filter, view, pageSize, pageToken, orderBy	Lists Realms in a given project and location.
create	insert	projectsId, locationsId	realmId, requestId	Creates a new Realm in a given project and location.
patch	update	projectsId, locationsId, realmsId	updateMask, requestId	Updates the parameters of a single Realm.
delete	delete	projectsId, locationsId, realmsId	requestId, force	Deletes a single Realm.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
locationsId	string
projectsId	string
realmsId	string
filter	string
force	boolean
orderBy	string
pageSize	integer (int32)
pageToken	string
realmId	string
requestId	string
updateMask	string (google-fieldmask)
view	string

SELECT examples

get

Gets details of a single Realm.

SELECT
name,
aggregatedData,
createTime,
discoveryMetadata,
ipVersion,
labels,
managementType,
registryBook,
trafficType,
updateTime
FROM google.cloudnumberregistry.realms
WHERE projectsId = '{{ projectsId }}' -- required
AND locationsId = '{{ locationsId }}' -- required
AND realmsId = '{{ realmsId }}' -- required
AND view = '{{ view }}'
;

list

Lists Realms in a given project and location.

SELECT
*
FROM google.cloudnumberregistry.realms
WHERE projectsId = '{{ projectsId }}' -- required
AND locationsId = '{{ locationsId }}' -- required
AND filter = '{{ filter }}'
AND view = '{{ view }}'
AND pageSize = '{{ pageSize }}'
AND pageToken = '{{ pageToken }}'
AND orderBy = '{{ orderBy }}'
;

INSERT examples

create

Creates a new Realm in a given project and location.

INSERT INTO google.cloudnumberregistry.realms (
data__registryBook,
data__labels,
data__name,
data__managementType,
data__ipVersion,
data__trafficType,
projectsId,
locationsId,
realmId,
requestId
)
SELECT 
'{{ registryBook }}',
'{{ labels }}',
'{{ name }}',
'{{ managementType }}',
'{{ ipVersion }}',
'{{ trafficType }}',
'{{ projectsId }}',
'{{ locationsId }}',
'{{ realmId }}',
'{{ requestId }}'
RETURNING
name,
done,
error,
metadata,
response
;

Manifest

# Description fields are for documentation purposes
- name: realms
props:
  - name: projectsId
    value: "{{ projectsId }}"
    description: Required parameter for the realms resource.
  - name: locationsId
    value: "{{ locationsId }}"
    description: Required parameter for the realms resource.
  - name: registryBook
    value: "{{ registryBook }}"
    description: |
      Required. Name of the RegistryBook that claims the Realm.
  - name: labels
    value: "{{ labels }}"
    description: |
      Optional. User-defined labels.
  - name: name
    value: "{{ name }}"
    description: |
      Required. Identifier. The resource name of the Realm.
  - name: managementType
    value: "{{ managementType }}"
    description: |
      Optional. Management type of the Realm.
    valid_values: ['MANAGEMENT_TYPE_UNSPECIFIED', 'CNR', 'USER']
  - name: ipVersion
    value: "{{ ipVersion }}"
    description: |
      Optional. IP version of the Realm.
    valid_values: ['IP_VERSION_UNSPECIFIED', 'IPV4', 'IPV6']
  - name: trafficType
    value: "{{ trafficType }}"
    description: |
      Required. Traffic type of the Realm.
    valid_values: ['TRAFFIC_TYPE_UNSPECIFIED', 'UNSET', 'INTERNET', 'PRIVATE', 'LINKLOCAL']
  - name: realmId
    value: "{{ realmId }}"
  - name: requestId
    value: "{{ requestId }}"

UPDATE examples

patch

Updates the parameters of a single Realm.

UPDATE google.cloudnumberregistry.realms
SET 
data__registryBook = '{{ registryBook }}',
data__labels = '{{ labels }}',
data__name = '{{ name }}',
data__managementType = '{{ managementType }}',
data__ipVersion = '{{ ipVersion }}',
data__trafficType = '{{ trafficType }}'
WHERE 
projectsId = '{{ projectsId }}' --required
AND locationsId = '{{ locationsId }}' --required
AND realmsId = '{{ realmsId }}' --required
AND updateMask = '{{ updateMask}}'
AND requestId = '{{ requestId}}'
RETURNING
name,
done,
error,
metadata,
response;

DELETE examples

delete

Deletes a single Realm.

DELETE FROM google.cloudnumberregistry.realms
WHERE projectsId = '{{ projectsId }}' --required
AND locationsId = '{{ locationsId }}' --required
AND realmsId = '{{ realmsId }}' --required
AND requestId = '{{ requestId }}'
AND force = '{{ force }}'
;