authorized_views

Creates, updates, deletes, gets or lists an authorized_views resource.

Overview

Name	authorized_views
Type	Resource
Id	google.bigtableadmin.authorized_views

Fields

The following fields are returned by SELECT queries:

get

Name	Datatype	Description
name	string	Identifier. The name of this AuthorizedView. Values are of the form projects/{project}/instances/{instance}/tables/{table}/authorizedViews/{authorized_view}
deletionProtection	boolean	Set to true to make the AuthorizedView protected against deletion. The parent Table and containing Instance cannot be deleted if an AuthorizedView has this bit set.
etag	string	The etag for this AuthorizedView. If this is provided on update, it must match the server's etag. The server returns ABORTED error on a mismatched etag.
subsetView	object	An AuthorizedView permitting access to an explicit subset of a Table. (id: GoogleBigtableAdminV2AuthorizedViewSubsetView)

list

Name	Datatype	Description
name	string	Identifier. The name of this AuthorizedView. Values are of the form projects/{project}/instances/{instance}/tables/{table}/authorizedViews/{authorized_view}
deletionProtection	boolean	Set to true to make the AuthorizedView protected against deletion. The parent Table and containing Instance cannot be deleted if an AuthorizedView has this bit set.
etag	string	The etag for this AuthorizedView. If this is provided on update, it must match the server's etag. The server returns ABORTED error on a mismatched etag.
subsetView	object	An AuthorizedView permitting access to an explicit subset of a Table. (id: GoogleBigtableAdminV2AuthorizedViewSubsetView)

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	projectsId, instancesId, tablesId, authorizedViewsId	view	Gets information from a specified AuthorizedView.
list	select	projectsId, instancesId, tablesId	pageSize, pageToken, view	Lists all AuthorizedViews from a specific table.
create	insert	projectsId, instancesId, tablesId	authorizedViewId	Creates a new AuthorizedView in a table.
patch	update	projectsId, instancesId, tablesId, authorizedViewsId	ignoreWarnings, updateMask	Updates an AuthorizedView in a table.
delete	delete	projectsId, instancesId, tablesId, authorizedViewsId	etag	Permanently deletes a specified AuthorizedView.

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
authorizedViewsId	string
instancesId	string
projectsId	string
tablesId	string
authorizedViewId	string
etag	string
ignoreWarnings	boolean
pageSize	integer (int32)
pageToken	string
updateMask	string (google-fieldmask)
view	string

SELECT examples

get

Gets information from a specified AuthorizedView.

SELECT
name,
deletionProtection,
etag,
subsetView
FROM google.bigtableadmin.authorized_views
WHERE projectsId = '{{ projectsId }}' -- required
AND instancesId = '{{ instancesId }}' -- required
AND tablesId = '{{ tablesId }}' -- required
AND authorizedViewsId = '{{ authorizedViewsId }}' -- required
AND view = '{{ view }}'
;

list

Lists all AuthorizedViews from a specific table.

SELECT
name,
deletionProtection,
etag,
subsetView
FROM google.bigtableadmin.authorized_views
WHERE projectsId = '{{ projectsId }}' -- required
AND instancesId = '{{ instancesId }}' -- required
AND tablesId = '{{ tablesId }}' -- required
AND pageSize = '{{ pageSize }}'
AND pageToken = '{{ pageToken }}'
AND view = '{{ view }}'
;

INSERT examples

create

Creates a new AuthorizedView in a table.

INSERT INTO google.bigtableadmin.authorized_views (
data__deletionProtection,
data__etag,
data__name,
data__subsetView,
projectsId,
instancesId,
tablesId,
authorizedViewId
)
SELECT 
{{ deletionProtection }},
'{{ etag }}',
'{{ name }}',
'{{ subsetView }}',
'{{ projectsId }}',
'{{ instancesId }}',
'{{ tablesId }}',
'{{ authorizedViewId }}'
RETURNING
name,
done,
error,
metadata,
response
;

Manifest

# Description fields are for documentation purposes
- name: authorized_views
props:
  - name: projectsId
    value: "{{ projectsId }}"
    description: Required parameter for the authorized_views resource.
  - name: instancesId
    value: "{{ instancesId }}"
    description: Required parameter for the authorized_views resource.
  - name: tablesId
    value: "{{ tablesId }}"
    description: Required parameter for the authorized_views resource.
  - name: deletionProtection
    value: {{ deletionProtection }}
    description: |
      Set to true to make the AuthorizedView protected against deletion. The parent Table and containing Instance cannot be deleted if an AuthorizedView has this bit set.
  - name: etag
    value: "{{ etag }}"
    description: |
      The etag for this AuthorizedView. If this is provided on update, it must match the server's etag. The server returns ABORTED error on a mismatched etag.
  - name: name
    value: "{{ name }}"
    description: |
      Identifier. The name of this AuthorizedView. Values are of the form `projects/{project}/instances/{instance}/tables/{table}/authorizedViews/{authorized_view}`
  - name: subsetView
    description: |
      An AuthorizedView permitting access to an explicit subset of a Table.
    value:
      familySubsets: "{{ familySubsets }}"
      rowPrefixes:
        - "{{ rowPrefixes }}"
  - name: authorizedViewId
    value: "{{ authorizedViewId }}"

UPDATE examples

patch

Updates an AuthorizedView in a table.

UPDATE google.bigtableadmin.authorized_views
SET 
data__deletionProtection = {{ deletionProtection }},
data__etag = '{{ etag }}',
data__name = '{{ name }}',
data__subsetView = '{{ subsetView }}'
WHERE 
projectsId = '{{ projectsId }}' --required
AND instancesId = '{{ instancesId }}' --required
AND tablesId = '{{ tablesId }}' --required
AND authorizedViewsId = '{{ authorizedViewsId }}' --required
AND ignoreWarnings = {{ ignoreWarnings}}
AND updateMask = '{{ updateMask}}'
RETURNING
name,
done,
error,
metadata,
response;

DELETE examples

delete

Permanently deletes a specified AuthorizedView.

DELETE FROM google.bigtableadmin.authorized_views
WHERE projectsId = '{{ projectsId }}' --required
AND instancesId = '{{ instancesId }}' --required
AND tablesId = '{{ tablesId }}' --required
AND authorizedViewsId = '{{ authorizedViewsId }}' --required
AND etag = '{{ etag }}'
;