Cloud Bigtable V2 Client - Class AuthorizedView (2.2.1)

Reference documentation and code samples for the Cloud Bigtable V2 Client class AuthorizedView.

AuthorizedViews represent subsets of a particular Cloud Bigtable table. Users can configure access to each Authorized View independently from the table and use the existing Data APIs to access the subset of data.

Generated from protobuf message google.bigtable.admin.v2.AuthorizedView

Namespace

Google \ Cloud \ Bigtable \ Admin \ V2

Methods

__construct

Constructor.

Parameters
Name Description
data array

Optional. Data for populating the Message object.

↳ name string

Identifier. The name of this AuthorizedView. Values are of the form projects/{project}/instances/{instance}/tables/{table}/authorizedViews/{authorized_view}

↳ subset_view Google\Cloud\Bigtable\Admin\V2\AuthorizedView\SubsetView

An AuthorizedView permitting access to an explicit subset of a Table.

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

↳ deletion_protection bool

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.

getName

Identifier. The name of this AuthorizedView.

Values are of the form projects/{project}/instances/{instance}/tables/{table}/authorizedViews/{authorized_view}

Returns
Type Description
string

setName

Identifier. The name of this AuthorizedView.

Values are of the form projects/{project}/instances/{instance}/tables/{table}/authorizedViews/{authorized_view}

Parameter
Name Description
var string
Returns
Type Description
$this

getSubsetView

An AuthorizedView permitting access to an explicit subset of a Table.

Returns
Type Description
Google\Cloud\Bigtable\Admin\V2\AuthorizedView\SubsetView|null

hasSubsetView

setSubsetView

An AuthorizedView permitting access to an explicit subset of a Table.

Parameter
Name Description
var Google\Cloud\Bigtable\Admin\V2\AuthorizedView\SubsetView
Returns
Type Description
$this

getEtag

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.

Returns
Type Description
string

setEtag

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.

Parameter
Name Description
var string
Returns
Type Description
$this

getDeletionProtection

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.

Returns
Type Description
bool

setDeletionProtection

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.

Parameter
Name Description
var bool
Returns
Type Description
$this

getAuthorizedView

Returns
Type Description
string