registry_books

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

Overview

Name	registry_books
Type	Resource
Id	google.cloudnumberregistry.registry_books

Fields

The following fields are returned by SELECT queries:

get

Name	Datatype	Description
name	string	Required. Identifier. The resource name of the RegistryBook.
aggregatedData	object	Output only. Aggregated data for the RegistryBook. Populated only when the view is AGGREGATE. (id: AggregatedData)
claimedScopes	array	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.
createTime	string (google-datetime)	Output only. The time at which the RegistryBook was created.
isDefault	boolean	Output only. Whether the RegistryBook is the default one.
labels	object	Optional. User-defined labels.
updateTime	string (google-datetime)	Output only. The time at which the RegistryBook was last updated.

list

Name	Datatype	Description
name	string	Required. Identifier. The resource name of the RegistryBook.
aggregatedData	object	Output only. Aggregated data for the RegistryBook. Populated only when the view is AGGREGATE. (id: AggregatedData)
claimedScopes	array	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.
createTime	string (google-datetime)	Output only. The time at which the RegistryBook was created.
isDefault	boolean	Output only. Whether the RegistryBook is the default one.
labels	object	Optional. User-defined labels.
updateTime	string (google-datetime)	Output only. The time at which the RegistryBook was last updated.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	projectsId, locationsId, registryBooksId	view	Gets details of a single RegistryBook.
list	select	projectsId, locationsId	orderBy, pageToken, pageSize, view, filter	Lists RegistryBooks in a given project and location.
create	insert	projectsId, locationsId	registryBookId, requestId	Creates a new RegistryBook in a given project and location.
patch	update	projectsId, locationsId, registryBooksId	updateMask, requestId	Updates the parameters of a single RegistryBook.
delete	delete	projectsId, locationsId, registryBooksId	force, requestId	Deletes a single RegistryBook.
search_ip_resources	exec	projectsId, locationsId, registryBooksId		Searches IP resources in a given RegistryBook.

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
registryBooksId	string
filter	string
force	boolean
orderBy	string
pageSize	integer (int32)
pageToken	string
registryBookId	string
requestId	string
updateMask	string (google-fieldmask)
view	string

SELECT examples

get

Gets details of a single RegistryBook.

SELECT
name,
aggregatedData,
claimedScopes,
createTime,
isDefault,
labels,
updateTime
FROM google.cloudnumberregistry.registry_books
WHERE projectsId = '{{ projectsId }}' -- required
AND locationsId = '{{ locationsId }}' -- required
AND registryBooksId = '{{ registryBooksId }}' -- required
AND view = '{{ view }}'
;

list

Lists RegistryBooks in a given project and location.

SELECT
name,
aggregatedData,
claimedScopes,
createTime,
isDefault,
labels,
updateTime
FROM google.cloudnumberregistry.registry_books
WHERE projectsId = '{{ projectsId }}' -- required
AND locationsId = '{{ locationsId }}' -- required
AND orderBy = '{{ orderBy }}'
AND pageToken = '{{ pageToken }}'
AND pageSize = '{{ pageSize }}'
AND view = '{{ view }}'
AND filter = '{{ filter }}'
;

INSERT examples

create

Creates a new RegistryBook in a given project and location.

INSERT INTO google.cloudnumberregistry.registry_books (
data__labels,
data__name,
data__claimedScopes,
projectsId,
locationsId,
registryBookId,
requestId
)
SELECT 
'{{ labels }}',
'{{ name }}',
'{{ claimedScopes }}',
'{{ projectsId }}',
'{{ locationsId }}',
'{{ registryBookId }}',
'{{ requestId }}'
RETURNING
name,
done,
error,
metadata,
response
;

Manifest

# Description fields are for documentation purposes
- name: registry_books
props:
  - name: projectsId
    value: "{{ projectsId }}"
    description: Required parameter for the registry_books resource.
  - name: locationsId
    value: "{{ locationsId }}"
    description: Required parameter for the registry_books resource.
  - name: labels
    value: "{{ labels }}"
    description: |
      Optional. User-defined labels.
  - name: name
    value: "{{ name }}"
    description: |
      Required. Identifier. The resource name of the RegistryBook.
  - name: claimedScopes
    value:
      - "{{ claimedScopes }}"
    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.
  - name: registryBookId
    value: "{{ registryBookId }}"
  - name: requestId
    value: "{{ requestId }}"

UPDATE examples

patch

Updates the parameters of a single RegistryBook.

UPDATE google.cloudnumberregistry.registry_books
SET 
data__labels = '{{ labels }}',
data__name = '{{ name }}',
data__claimedScopes = '{{ claimedScopes }}'
WHERE 
projectsId = '{{ projectsId }}' --required
AND locationsId = '{{ locationsId }}' --required
AND registryBooksId = '{{ registryBooksId }}' --required
AND updateMask = '{{ updateMask}}'
AND requestId = '{{ requestId}}'
RETURNING
name,
done,
error,
metadata,
response;

DELETE examples

delete

Deletes a single RegistryBook.

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

Lifecycle Methods

search_ip_resources

Searches IP resources in a given RegistryBook.

EXEC google.cloudnumberregistry.registry_books.search_ip_resources 
@projectsId='{{ projectsId }}' --required, 
@locationsId='{{ locationsId }}' --required, 
@registryBooksId='{{ registryBooksId }}' --required 
@@json=
'{
"searchResourceTypes": "{{ searchResourceTypes }}", 
"showUtilization": {{ showUtilization }}, 
"pageSize": {{ pageSize }}, 
"query": "{{ query }}", 
"orderBy": "{{ orderBy }}", 
"pageToken": "{{ pageToken }}"
}'
;