Class: Google::Cloud::Bigquery::Dataset::Access

Inherits:
Object
  • Object
show all
Defined in:
lib/google/cloud/bigquery/dataset/access.rb

Overview

Dataset Access Control

Represents the access control rules for a Google::Cloud::Bigquery::Dataset.

Examples:

require "google/cloud/bigquery"

bigquery = Google::Cloud::Bigquery.new
dataset = bigquery.dataset "my_dataset"

dataset.access do |access|
  access.add_owner_group "[email protected]"
  access.add_writer_user "[email protected]"
  access.remove_writer_user "[email protected]"
  access.add_reader_special :all
end

See Also:

Instance Method Summary collapse

Instance Method Details

#add_owner_domain(domain) ⇒ Object

Add owner access to a domain.

Examples:

require "google/cloud/bigquery"

bigquery = Google::Cloud::Bigquery.new
dataset = bigquery.dataset "my_dataset"

dataset.access do |access|
  access.add_owner_domain "example.com"
end

Parameters:



350
351
352
# File 'lib/google/cloud/bigquery/dataset/access.rb', line 350

def add_owner_domain domain
  add_access_role_scope_value :owner, :domain, domain
end

#add_owner_group(email) ⇒ Object

Add owner access to a group.

Examples:

require "google/cloud/bigquery"

bigquery = Google::Cloud::Bigquery.new
dataset = bigquery.dataset "my_dataset"

dataset.access do |access|
  access.add_owner_group "[email protected]"
end

Parameters:

  • email (String)

    The email address for the entity.



330
331
332
# File 'lib/google/cloud/bigquery/dataset/access.rb', line 330

def add_owner_group email
  add_access_role_scope_value :owner, :group, email
end

#add_owner_special(group) ⇒ Object

Add owner access to a special group.

Examples:

require "google/cloud/bigquery"

bigquery = Google::Cloud::Bigquery.new
dataset = bigquery.dataset "my_dataset"

dataset.access do |access|
  access.add_owner_special :all
end

Parameters:

  • group (String)

    Accepted values are owners, writers, readers, and all.



370
371
372
# File 'lib/google/cloud/bigquery/dataset/access.rb', line 370

def add_owner_special group
  add_access_role_scope_value :owner, :special, group
end

#add_owner_user(email) ⇒ Object

Add owner access to a user.

Examples:

require "google/cloud/bigquery"

bigquery = Google::Cloud::Bigquery.new
dataset = bigquery.dataset "my_dataset"

dataset.access do |access|
  access.add_owner_user "[email protected]"
end

Parameters:

  • email (String)

    The email address for the entity.



311
312
313
# File 'lib/google/cloud/bigquery/dataset/access.rb', line 311

def add_owner_user email
  add_access_role_scope_value :owner, :user, email
end

#add_reader_domain(domain) ⇒ Object

Add reader access to a domain.

Examples:

require "google/cloud/bigquery"

bigquery = Google::Cloud::Bigquery.new
dataset = bigquery.dataset "my_dataset"

dataset.access do |access|
  access.add_reader_domain "example.com"
end

Parameters:



167
168
169
# File 'lib/google/cloud/bigquery/dataset/access.rb', line 167

def add_reader_domain domain
  add_access_role_scope_value :reader, :domain, domain
end

#add_reader_group(email) ⇒ Object

Add reader access to a group.

Examples:

require "google/cloud/bigquery"

bigquery = Google::Cloud::Bigquery.new
dataset = bigquery.dataset "my_dataset"

dataset.access do |access|
  access.add_reader_group "[email protected]"
end

Parameters:

  • email (String)

    The email address for the entity.



147
148
149
# File 'lib/google/cloud/bigquery/dataset/access.rb', line 147

def add_reader_group email
  add_access_role_scope_value :reader, :group, email
end

#add_reader_special(group) ⇒ Object

Add reader access to a special group.

Examples:

require "google/cloud/bigquery"

bigquery = Google::Cloud::Bigquery.new
dataset = bigquery.dataset "my_dataset"

dataset.access do |access|
  access.add_reader_special :all
end

Parameters:

  • group (String)

    Accepted values are owners, writers, readers, and all.



187
188
189
# File 'lib/google/cloud/bigquery/dataset/access.rb', line 187

def add_reader_special group
  add_access_role_scope_value :reader, :special, group
end

#add_reader_user(email) ⇒ Object

Add reader access to a user.

Examples:

require "google/cloud/bigquery"

bigquery = Google::Cloud::Bigquery.new
dataset = bigquery.dataset "my_dataset"

dataset.access do |access|
  access.add_reader_user "[email protected]"
end

Parameters:

  • email (String)

    The email address for the entity.



128
129
130
# File 'lib/google/cloud/bigquery/dataset/access.rb', line 128

def add_reader_user email
  add_access_role_scope_value :reader, :user, email
end

#add_reader_view(view) ⇒ Object

Add reader access to a view.

Examples:

require "google/cloud/bigquery"

bigquery = Google::Cloud::Bigquery.new
dataset = bigquery.dataset "my_dataset"
other_dataset = bigquery.dataset "my_other_dataset"

view = other_dataset.table "my_view"

dataset.access do |access|
  access.add_reader_view view
end

Parameters:



214
215
216
# File 'lib/google/cloud/bigquery/dataset/access.rb', line 214

def add_reader_view view
  add_access_view view
end

#add_writer_domain(domain) ⇒ Object

Add writer access to a domain.

Examples:

require "google/cloud/bigquery"

bigquery = Google::Cloud::Bigquery.new
dataset = bigquery.dataset "my_dataset"

dataset.access do |access|
  access.add_writer_domain "example.com"
end

Parameters:



272
273
274
# File 'lib/google/cloud/bigquery/dataset/access.rb', line 272

def add_writer_domain domain
  add_access_role_scope_value :writer, :domain, domain
end

#add_writer_group(email) ⇒ Object

Add writer access to a group.

Examples:

require "google/cloud/bigquery"

bigquery = Google::Cloud::Bigquery.new
dataset = bigquery.dataset "my_dataset"

dataset.access do |access|
  access.add_writer_group "[email protected]"
end

Parameters:

  • email (String)

    The email address for the entity.



252
253
254
# File 'lib/google/cloud/bigquery/dataset/access.rb', line 252

def add_writer_group email
  add_access_role_scope_value :writer, :group, email
end

#add_writer_special(group) ⇒ Object

Add writer access to a special group.

Examples:

require "google/cloud/bigquery"

bigquery = Google::Cloud::Bigquery.new
dataset = bigquery.dataset "my_dataset"

dataset.access do |access|
  access.add_writer_special :all
end

Parameters:

  • group (String)

    Accepted values are owners, writers, readers, and all.



292
293
294
# File 'lib/google/cloud/bigquery/dataset/access.rb', line 292

def add_writer_special group
  add_access_role_scope_value :writer, :special, group
end

#add_writer_user(email) ⇒ Object

Add writer access to a user.

Examples:

require "google/cloud/bigquery"

bigquery = Google::Cloud::Bigquery.new
dataset = bigquery.dataset "my_dataset"

dataset.access do |access|
  access.add_writer_user "[email protected]"
end

Parameters:

  • email (String)

    The email address for the entity.



233
234
235
# File 'lib/google/cloud/bigquery/dataset/access.rb', line 233

def add_writer_user email
  add_access_role_scope_value :writer, :user, email
end

#owner_domain?(domain) ⇒ Boolean

Checks owner access for a domain.

Examples:

require "google/cloud/bigquery"

bigquery = Google::Cloud::Bigquery.new
dataset = bigquery.dataset "my_dataset"

access = dataset.access
access.owner_domain? "example.com" #=> false

Parameters:

Returns:

  • (Boolean)


860
861
862
# File 'lib/google/cloud/bigquery/dataset/access.rb', line 860

def owner_domain? domain
  lookup_access_role_scope_value :owner, :domain, domain
end

#owner_group?(email) ⇒ Boolean

Checks owner access for a group.

Examples:

require "google/cloud/bigquery"

bigquery = Google::Cloud::Bigquery.new
dataset = bigquery.dataset "my_dataset"

access = dataset.access
access.owner_group? "[email protected]" #=> false

Parameters:

  • email (String)

    The email address for the entity.

Returns:

  • (Boolean)


841
842
843
# File 'lib/google/cloud/bigquery/dataset/access.rb', line 841

def owner_group? email
  lookup_access_role_scope_value :owner, :group, email
end

#owner_special?(group) ⇒ Boolean

Checks owner access for a special group.

Examples:

require "google/cloud/bigquery"

bigquery = Google::Cloud::Bigquery.new
dataset = bigquery.dataset "my_dataset"

access = dataset.access
access.owner_special? :all #=> false

Parameters:

  • group (String)

    Accepted values are owners, writers, readers, and all.

Returns:

  • (Boolean)


879
880
881
# File 'lib/google/cloud/bigquery/dataset/access.rb', line 879

def owner_special? group
  lookup_access_role_scope_value :owner, :special, group
end

#owner_user?(email) ⇒ Boolean

Checks owner access for a user.

Examples:

require "google/cloud/bigquery"

bigquery = Google::Cloud::Bigquery.new
dataset = bigquery.dataset "my_dataset"

access = dataset.access
access.owner_user? "[email protected]" #=> false

Parameters:

  • email (String)

    The email address for the entity.

Returns:

  • (Boolean)


823
824
825
# File 'lib/google/cloud/bigquery/dataset/access.rb', line 823

def owner_user? email
  lookup_access_role_scope_value :owner, :user, email
end

#reader_domain?(domain) ⇒ Boolean

Checks reader access for a domain.

Examples:

require "google/cloud/bigquery"

bigquery = Google::Cloud::Bigquery.new
dataset = bigquery.dataset "my_dataset"

access = dataset.access
access.reader_domain? "example.com" #=> false

Parameters:

Returns:

  • (Boolean)


686
687
688
# File 'lib/google/cloud/bigquery/dataset/access.rb', line 686

def reader_domain? domain
  lookup_access_role_scope_value :reader, :domain, domain
end

#reader_group?(email) ⇒ Boolean

Checks reader access for a group.

Examples:

require "google/cloud/bigquery"

bigquery = Google::Cloud::Bigquery.new
dataset = bigquery.dataset "my_dataset"

access = dataset.access
access.reader_group? "[email protected]" #=> false

Parameters:

  • email (String)

    The email address for the entity.

Returns:

  • (Boolean)


667
668
669
# File 'lib/google/cloud/bigquery/dataset/access.rb', line 667

def reader_group? email
  lookup_access_role_scope_value :reader, :group, email
end

#reader_special?(group) ⇒ Boolean

Checks reader access for a special group.

Examples:

require "google/cloud/bigquery"

bigquery = Google::Cloud::Bigquery.new
dataset = bigquery.dataset "my_dataset"

access = dataset.access
access.reader_special? :all #=> false

Parameters:

  • group (String)

    Accepted values are owners, writers, readers, and all.

Returns:

  • (Boolean)


705
706
707
# File 'lib/google/cloud/bigquery/dataset/access.rb', line 705

def reader_special? group
  lookup_access_role_scope_value :reader, :special, group
end

#reader_user?(email) ⇒ Boolean

Checks reader access for a user.

Examples:

require "google/cloud/bigquery"

bigquery = Google::Cloud::Bigquery.new
dataset = bigquery.dataset "my_dataset"

access = dataset.access
access.reader_user? "[email protected]" #=> false

Parameters:

  • email (String)

    The email address for the entity.

Returns:

  • (Boolean)


649
650
651
# File 'lib/google/cloud/bigquery/dataset/access.rb', line 649

def reader_user? email
  lookup_access_role_scope_value :reader, :user, email
end

#reader_view?(view) ⇒ Boolean

Checks reader access for a view.

Examples:

require "google/cloud/bigquery"

bigquery = Google::Cloud::Bigquery.new
dataset = bigquery.dataset "my_dataset"
other_dataset = bigquery.dataset "my_other_dataset"

view = other_dataset.table "my_view"

access = dataset.access
access.reader_view? view #=> false

Parameters:

Returns:

  • (Boolean)


731
732
733
# File 'lib/google/cloud/bigquery/dataset/access.rb', line 731

def reader_view? view
  lookup_access_view view
end

#remove_owner_domain(domain) ⇒ Object

Remove owner access from a domain.

Examples:

require "google/cloud/bigquery"

bigquery = Google::Cloud::Bigquery.new
dataset = bigquery.dataset "my_dataset"

dataset.access do |access|
  access.remove_owner_domain "example.com"
end

Parameters:



611
612
613
# File 'lib/google/cloud/bigquery/dataset/access.rb', line 611

def remove_owner_domain domain
  remove_access_role_scope_value :owner, :domain, domain
end

#remove_owner_group(email) ⇒ Object

Remove owner access from a group.

Examples:

require "google/cloud/bigquery"

bigquery = Google::Cloud::Bigquery.new
dataset = bigquery.dataset "my_dataset"

dataset.access do |access|
  access.remove_owner_group "[email protected]"
end

Parameters:

  • email (String)

    The email address for the entity.



591
592
593
# File 'lib/google/cloud/bigquery/dataset/access.rb', line 591

def remove_owner_group email
  remove_access_role_scope_value :owner, :group, email
end

#remove_owner_special(group) ⇒ Object

Remove owner access from a special group.

Examples:

require "google/cloud/bigquery"

bigquery = Google::Cloud::Bigquery.new
dataset = bigquery.dataset "my_dataset"

dataset.access do |access|
  access.remove_owner_special :all
end

Parameters:

  • group (String)

    Accepted values are owners, writers, readers, and all.



631
632
633
# File 'lib/google/cloud/bigquery/dataset/access.rb', line 631

def remove_owner_special group
  remove_access_role_scope_value :owner, :special, group
end

#remove_owner_user(email) ⇒ Object

Remove owner access from a user.

Examples:

require "google/cloud/bigquery"

bigquery = Google::Cloud::Bigquery.new
dataset = bigquery.dataset "my_dataset"

dataset.access do |access|
  access.remove_owner_user "[email protected]"
end

Parameters:

  • email (String)

    The email address for the entity.



572
573
574
# File 'lib/google/cloud/bigquery/dataset/access.rb', line 572

def remove_owner_user email
  remove_access_role_scope_value :owner, :user, email
end

#remove_reader_domain(domain) ⇒ Object

Remove reader access from a domain.

Examples:

require "google/cloud/bigquery"

bigquery = Google::Cloud::Bigquery.new
dataset = bigquery.dataset "my_dataset"

dataset.access do |access|
  access.remove_reader_domain "example.com"
end

Parameters:



428
429
430
# File 'lib/google/cloud/bigquery/dataset/access.rb', line 428

def remove_reader_domain domain
  remove_access_role_scope_value :reader, :domain, domain
end

#remove_reader_group(email) ⇒ Object

Remove reader access from a group.

Examples:

require "google/cloud/bigquery"

bigquery = Google::Cloud::Bigquery.new
dataset = bigquery.dataset "my_dataset"

dataset.access do |access|
  access.remove_reader_group "[email protected]"
end

Parameters:

  • email (String)

    The email address for the entity.



408
409
410
# File 'lib/google/cloud/bigquery/dataset/access.rb', line 408

def remove_reader_group email
  remove_access_role_scope_value :reader, :group, email
end

#remove_reader_special(group) ⇒ Object

Remove reader access from a special group.

Examples:

require "google/cloud/bigquery"

bigquery = Google::Cloud::Bigquery.new
dataset = bigquery.dataset "my_dataset"

dataset.access do |access|
  access.remove_reader_special :all
end

Parameters:

  • group (String)

    Accepted values are owners, writers, readers, and all.



448
449
450
# File 'lib/google/cloud/bigquery/dataset/access.rb', line 448

def remove_reader_special group
  remove_access_role_scope_value :reader, :special, group
end

#remove_reader_user(email) ⇒ Object

Remove reader access from a user.

Examples:

require "google/cloud/bigquery"

bigquery = Google::Cloud::Bigquery.new
dataset = bigquery.dataset "my_dataset"

dataset.access do |access|
  access.remove_reader_user "[email protected]"
end

Parameters:

  • email (String)

    The email address for the entity.



389
390
391
# File 'lib/google/cloud/bigquery/dataset/access.rb', line 389

def remove_reader_user email
  remove_access_role_scope_value :reader, :user, email
end

#remove_reader_view(view) ⇒ Object

Remove reader access from a view.

Examples:

require "google/cloud/bigquery"

bigquery = Google::Cloud::Bigquery.new
dataset = bigquery.dataset "my_dataset"
other_dataset = bigquery.dataset "my_other_dataset"

view = other_dataset.table "my_view"

dataset.access do |access|
  access.remove_reader_view view
end

Parameters:



475
476
477
# File 'lib/google/cloud/bigquery/dataset/access.rb', line 475

def remove_reader_view view
  remove_access_view view
end

#remove_writer_domain(domain) ⇒ Object

Remove writer access from a domain.

Examples:

require "google/cloud/bigquery"

bigquery = Google::Cloud::Bigquery.new
dataset = bigquery.dataset "my_dataset"

dataset.access do |access|
  access.remove_writer_domain "example.com"
end

Parameters:



533
534
535
# File 'lib/google/cloud/bigquery/dataset/access.rb', line 533

def remove_writer_domain domain
  remove_access_role_scope_value :writer, :domain, domain
end

#remove_writer_group(email) ⇒ Object

Remove writer access from a group.

Examples:

require "google/cloud/bigquery"

bigquery = Google::Cloud::Bigquery.new
dataset = bigquery.dataset "my_dataset"

dataset.access do |access|
  access.remove_writer_group "[email protected]"
end

Parameters:

  • email (String)

    The email address for the entity.



513
514
515
# File 'lib/google/cloud/bigquery/dataset/access.rb', line 513

def remove_writer_group email
  remove_access_role_scope_value :writer, :group, email
end

#remove_writer_special(group) ⇒ Object

Remove writer access from a special group.

Examples:

require "google/cloud/bigquery"

bigquery = Google::Cloud::Bigquery.new
dataset = bigquery.dataset "my_dataset"

dataset.access do |access|
  access.remove_writer_special :all
end

Parameters:

  • group (String)

    Accepted values are owners, writers, readers, and all.



553
554
555
# File 'lib/google/cloud/bigquery/dataset/access.rb', line 553

def remove_writer_special group
  remove_access_role_scope_value :writer, :special, group
end

#remove_writer_user(email) ⇒ Object

Remove writer access from a user.

Examples:

require "google/cloud/bigquery"

bigquery = Google::Cloud::Bigquery.new
dataset = bigquery.dataset "my_dataset"

dataset.access do |access|
  access.remove_writer_user "[email protected]"
end

Parameters:

  • email (String)

    The email address for the entity.



494
495
496
# File 'lib/google/cloud/bigquery/dataset/access.rb', line 494

def remove_writer_user email
  remove_access_role_scope_value :writer, :user, email
end

#writer_domain?(domain) ⇒ Boolean

Checks writer access for a domain.

Examples:

require "google/cloud/bigquery"

bigquery = Google::Cloud::Bigquery.new
dataset = bigquery.dataset "my_dataset"

access = dataset.access
access.writer_domain? "example.com" #=> false

Parameters:

Returns:

  • (Boolean)


786
787
788
# File 'lib/google/cloud/bigquery/dataset/access.rb', line 786

def writer_domain? domain
  lookup_access_role_scope_value :writer, :domain, domain
end

#writer_group?(email) ⇒ Boolean

Checks writer access for a group.

Examples:

require "google/cloud/bigquery"

bigquery = Google::Cloud::Bigquery.new
dataset = bigquery.dataset "my_dataset"

access = dataset.access
access.writer_group? "[email protected]" #=> false

Parameters:

  • email (String)

    The email address for the entity.

Returns:

  • (Boolean)


767
768
769
# File 'lib/google/cloud/bigquery/dataset/access.rb', line 767

def writer_group? email
  lookup_access_role_scope_value :writer, :group, email
end

#writer_special?(group) ⇒ Boolean

Checks writer access for a special group.

Examples:

require "google/cloud/bigquery"

bigquery = Google::Cloud::Bigquery.new
dataset = bigquery.dataset "my_dataset"

access = dataset.access
access.writer_special? :all #=> false

Parameters:

  • group (String)

    Accepted values are owners, writers, readers, and all.

Returns:

  • (Boolean)


805
806
807
# File 'lib/google/cloud/bigquery/dataset/access.rb', line 805

def writer_special? group
  lookup_access_role_scope_value :writer, :special, group
end

#writer_user?(email) ⇒ Boolean

Checks writer access for a user.

Examples:

require "google/cloud/bigquery"

bigquery = Google::Cloud::Bigquery.new
dataset = bigquery.dataset "my_dataset"

access = dataset.access
access.writer_user? "[email protected]" #=> false

Parameters:

  • email (String)

    The email address for the entity.

Returns:

  • (Boolean)


749
750
751
# File 'lib/google/cloud/bigquery/dataset/access.rb', line 749

def writer_user? email
  lookup_access_role_scope_value :writer, :user, email
end