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 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 "owners@example.com"
  access.add_writer_user "writer@example.com"
  access.remove_writer_user "readers@example.com"
  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.



182
183
184
 
# File 'lib/google/cloud/bigquery/dataset/access.rb', line 182

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.



176
177
178
 
# File 'lib/google/cloud/bigquery/dataset/access.rb', line 176

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. Accepted values are owners, writers, readers, and all.



189
190
191
 
# File 'lib/google/cloud/bigquery/dataset/access.rb', line 189

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.



170
171
172
 
# File 'lib/google/cloud/bigquery/dataset/access.rb', line 170

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.



121
122
123
 
# File 'lib/google/cloud/bigquery/dataset/access.rb', line 121

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.



115
116
117
 
# File 'lib/google/cloud/bigquery/dataset/access.rb', line 115

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. Accepted values are owners, writers, readers, and all.



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

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.



109
110
111
 
# File 'lib/google/cloud/bigquery/dataset/access.rb', line 109

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. The view can be a Google::Cloud::Bigquery::View object, or a string identifier as specified by the Query Reference: +project_name:datasetId.tableId+.



139
140
141
 
# File 'lib/google/cloud/bigquery/dataset/access.rb', line 139

def add_reader_view view
  add_access_view view
end

#add_writer_domain(domain) ⇒ Object

Add writer access to a domain.



157
158
159
 
# File 'lib/google/cloud/bigquery/dataset/access.rb', line 157

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.



151
152
153
 
# File 'lib/google/cloud/bigquery/dataset/access.rb', line 151

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. Accepted values are owners, writers, readers, and all.



164
165
166
 
# File 'lib/google/cloud/bigquery/dataset/access.rb', line 164

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.



145
146
147
 
# File 'lib/google/cloud/bigquery/dataset/access.rb', line 145

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

#owner_domain?(domain) ⇒ Boolean

Checks owner access for a domain.

Returns:

  • (Boolean) 


354
355
356
 
# File 'lib/google/cloud/bigquery/dataset/access.rb', line 354

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

#owner_group?(email) ⇒ Boolean

Checks owner access for a group.

Returns:

  • (Boolean) 


348
349
350
 
# File 'lib/google/cloud/bigquery/dataset/access.rb', line 348

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

#owner_special?(group) ⇒ Boolean

Checks owner access for a special group. Accepted values are owners, writers, readers, and all.

Returns:

  • (Boolean) 


361
362
363
 
# File 'lib/google/cloud/bigquery/dataset/access.rb', line 361

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

#owner_user?(email) ⇒ Boolean

Checks owner access for a user.

Returns:

  • (Boolean) 


342
343
344
 
# File 'lib/google/cloud/bigquery/dataset/access.rb', line 342

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

#reader_domain?(domain) ⇒ Boolean

Checks reader access for a domain.

Returns:

  • (Boolean) 


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

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

#reader_group?(email) ⇒ Boolean

Checks reader access for a group.

Returns:

  • (Boolean) 


287
288
289
 
# File 'lib/google/cloud/bigquery/dataset/access.rb', line 287

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

#reader_special?(group) ⇒ Boolean

Checks reader access for a special group. Accepted values are owners, writers, readers, and all.

Returns:

  • (Boolean) 


300
301
302
 
# File 'lib/google/cloud/bigquery/dataset/access.rb', line 300

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

#reader_user?(email) ⇒ Boolean

Checks reader access for a user.

Returns:

  • (Boolean) 


281
282
283
 
# File 'lib/google/cloud/bigquery/dataset/access.rb', line 281

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

#reader_view?(view) ⇒ Boolean

Checks reader access for a view. The view can be a Google::Cloud::Bigquery::View object, or a string identifier as specified by the Query Reference: +project_name:datasetId.tableId+.

Returns:

  • (Boolean) 


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

def reader_view? view
  lookup_access_view view
end

#remove_owner_domain(domain) ⇒ Object

Remove owner access from a domain.



268
269
270
 
# File 'lib/google/cloud/bigquery/dataset/access.rb', line 268

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.



262
263
264
 
# File 'lib/google/cloud/bigquery/dataset/access.rb', line 262

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. Accepted values are owners, writers, readers, and all.



275
276
277
 
# File 'lib/google/cloud/bigquery/dataset/access.rb', line 275

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.



256
257
258
 
# File 'lib/google/cloud/bigquery/dataset/access.rb', line 256

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.



207
208
209
 
# File 'lib/google/cloud/bigquery/dataset/access.rb', line 207

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.



201
202
203
 
# File 'lib/google/cloud/bigquery/dataset/access.rb', line 201

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. Accepted values are owners, writers, readers, and all.



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

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.



195
196
197
 
# File 'lib/google/cloud/bigquery/dataset/access.rb', line 195

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. The view can be a Google::Cloud::Bigquery::View object, or a string identifier as specified by the Query Reference: +project_name:datasetId.tableId+.



225
226
227
 
# File 'lib/google/cloud/bigquery/dataset/access.rb', line 225

def remove_reader_view view
  remove_access_view view
end

#remove_writer_domain(domain) ⇒ Object

Remove writer access from a domain.



243
244
245
 
# File 'lib/google/cloud/bigquery/dataset/access.rb', line 243

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.



237
238
239
 
# File 'lib/google/cloud/bigquery/dataset/access.rb', line 237

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. Accepted values are owners, writers, readers, and all.



250
251
252
 
# File 'lib/google/cloud/bigquery/dataset/access.rb', line 250

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.



231
232
233
 
# File 'lib/google/cloud/bigquery/dataset/access.rb', line 231

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

#writer_domain?(domain) ⇒ Boolean

Checks writer access for a domain.

Returns:

  • (Boolean) 


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

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

#writer_group?(email) ⇒ Boolean

Checks writer access for a group.

Returns:

  • (Boolean) 


323
324
325
 
# File 'lib/google/cloud/bigquery/dataset/access.rb', line 323

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

#writer_special?(group) ⇒ Boolean

Checks writer access for a special group. Accepted values are owners, writers, readers, and all.

Returns:

  • (Boolean) 


336
337
338
 
# File 'lib/google/cloud/bigquery/dataset/access.rb', line 336

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

#writer_user?(email) ⇒ Boolean

Checks writer access for a user.

Returns:

  • (Boolean) 


317
318
319
 
# File 'lib/google/cloud/bigquery/dataset/access.rb', line 317

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