Class: Gcloud::Bigquery::Dataset::Access

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

Overview

# Dataset Access Control

Represents the Access rules for a Gcloud::Bigquery::Dataset.

Examples:

require "gcloud"

gcloud = Gcloud.new
bigquery = gcloud.bigquery
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
  access.add_reader_view other_dataset_view_object
end

See Also:

Constant Summary collapse

ROLES = 
{ "reader" => "READER",
"writer" => "WRITER",
"owner"  => "OWNER" }
SCOPES = 
{ "user"           => "userByEmail",
"user_by_email"  => "userByEmail",
"userByEmail"    => "userByEmail",
"group"          => "groupByEmail",
"group_by_email" => "groupByEmail",
"groupByEmail"   => "groupByEmail",
"domain"         => "domain",
"special"        => "specialGroup",
"special_group"  => "specialGroup",
"specialGroup"   => "specialGroup",
"view"           => "view" }
GROUPS = 
{ "owners"                  => "projectOwners",
"project_owners"          => "projectOwners",
"projectOwners"           => "projectOwners",
"readers"                 => "projectReaders",
"project_readers"         => "projectReaders",
"projectReaders"          => "projectReaders",
"writers"                 => "projectWriters",
"project_writers"         => "projectWriters",
"projectWriters"          => "projectWriters",
"all"                     => "allAuthenticatedUsers",
"all_authenticated_users" => "allAuthenticatedUsers",
"allAuthenticatedUsers"   => "allAuthenticatedUsers" }

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(access, context) ⇒ Access

Initialized a new Access object. Must provide a valid Dataset object.



82
83
84
85
86
 
# File 'lib/gcloud/bigquery/dataset/access.rb', line 82

def initialize access, context
  @original   = access.dup
  @access     = access.dup
  @context    = context
end

Instance Attribute Details

#access ⇒ Object (readonly) 



76
77
78
 
# File 'lib/gcloud/bigquery/dataset/access.rb', line 76

def access
  @access
end

Instance Method Details

#add_owner_domain(domain) ⇒ Object

Add owner access to a domain.



179
180
181
 
# File 'lib/gcloud/bigquery/dataset/access.rb', line 179

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.



173
174
175
 
# File 'lib/gcloud/bigquery/dataset/access.rb', line 173

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



186
187
188
 
# File 'lib/gcloud/bigquery/dataset/access.rb', line 186

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.



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

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

#add_owner_view(view) ⇒ Object

Add owner access to a view. The view can be a Gcloud::Bigquery::View object, or a string identifier as specified by the [Query Reference](cloud.google.com/bigquery/query-reference#from): project_name:datasetId.tableId.



197
198
199
 
# File 'lib/gcloud/bigquery/dataset/access.rb', line 197

def add_owner_view view
  add_access_role_scope_value :owner, :view, view
end

#add_reader_domain(domain) ⇒ Object

Add reader access to a domain.



107
108
109
 
# File 'lib/gcloud/bigquery/dataset/access.rb', line 107

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.



101
102
103
 
# File 'lib/gcloud/bigquery/dataset/access.rb', line 101

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



114
115
116
 
# File 'lib/gcloud/bigquery/dataset/access.rb', line 114

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.



95
96
97
 
# File 'lib/gcloud/bigquery/dataset/access.rb', line 95

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 Gcloud::Bigquery::View object, or a string identifier as specified by the [Query Reference](cloud.google.com/bigquery/query-reference#from): project_name:datasetId.tableId.



125
126
127
 
# File 'lib/gcloud/bigquery/dataset/access.rb', line 125

def add_reader_view view
  add_access_role_scope_value :reader, :view, view
end

#add_writer_domain(domain) ⇒ Object

Add writer access to a domain.



143
144
145
 
# File 'lib/gcloud/bigquery/dataset/access.rb', line 143

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.



137
138
139
 
# File 'lib/gcloud/bigquery/dataset/access.rb', line 137

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



150
151
152
 
# File 'lib/gcloud/bigquery/dataset/access.rb', line 150

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.



131
132
133
 
# File 'lib/gcloud/bigquery/dataset/access.rb', line 131

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

#add_writer_view(view) ⇒ Object

Add writer access to a view. The view can be a Gcloud::Bigquery::View object, or a string identifier as specified by the [Query Reference](cloud.google.com/bigquery/query-reference#from): project_name:datasetId.tableId.



161
162
163
 
# File 'lib/gcloud/bigquery/dataset/access.rb', line 161

def add_writer_view view
  add_access_role_scope_value :writer, :view, view
end

#changed? ⇒ Boolean

Returns:

  • (Boolean) 


89
90
91
 
# File 'lib/gcloud/bigquery/dataset/access.rb', line 89

def changed?
  @original != @access
end

#owner_domain?(domain) ⇒ Boolean

Checks owner access for a domain.

Returns:

  • (Boolean) 


395
396
397
 
# File 'lib/gcloud/bigquery/dataset/access.rb', line 395

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) 


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

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) 


402
403
404
 
# File 'lib/gcloud/bigquery/dataset/access.rb', line 402

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) 


383
384
385
 
# File 'lib/gcloud/bigquery/dataset/access.rb', line 383

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

#owner_view?(view) ⇒ Boolean

Checks owner access for a view. The view can be a Gcloud::Bigquery::View object, or a string identifier as specified by the [Query Reference](cloud.google.com/bigquery/query-reference#from): project_name:datasetId.tableId.

Returns:

  • (Boolean) 


413
414
415
 
# File 'lib/gcloud/bigquery/dataset/access.rb', line 413

def owner_view? view
  lookup_access_role_scope_value :owner, :view, view
end

#reader_domain?(domain) ⇒ Boolean

Checks reader access for a domain.

Returns:

  • (Boolean) 


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

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) 


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

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) 


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

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) 


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

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 Gcloud::Bigquery::View object, or a string identifier as specified by the [Query Reference](cloud.google.com/bigquery/query-reference#from): project_name:datasetId.tableId.

Returns:

  • (Boolean) 


341
342
343
 
# File 'lib/gcloud/bigquery/dataset/access.rb', line 341

def reader_view? view
  lookup_access_role_scope_value :reader, :view, view
end

#remove_owner_domain(domain) ⇒ Object

Remove owner access from a domain.



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

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.



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

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



294
295
296
 
# File 'lib/gcloud/bigquery/dataset/access.rb', line 294

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.



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

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

#remove_owner_view(view) ⇒ Object

Remove owner access from a view. The view can be a Gcloud::Bigquery::View object, or a string identifier as specified by the [Query Reference](cloud.google.com/bigquery/query-reference#from): project_name:datasetId.tableId.



305
306
307
 
# File 'lib/gcloud/bigquery/dataset/access.rb', line 305

def remove_owner_view view
  remove_access_role_scope_value :owner, :view, view
end

#remove_reader_domain(domain) ⇒ Object

Remove reader access from a domain.



215
216
217
 
# File 'lib/gcloud/bigquery/dataset/access.rb', line 215

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.



209
210
211
 
# File 'lib/gcloud/bigquery/dataset/access.rb', line 209

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



222
223
224
 
# File 'lib/gcloud/bigquery/dataset/access.rb', line 222

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.



203
204
205
 
# File 'lib/gcloud/bigquery/dataset/access.rb', line 203

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 Gcloud::Bigquery::View object, or a string identifier as specified by the [Query Reference](cloud.google.com/bigquery/query-reference#from): project_name:datasetId.tableId.



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

def remove_reader_view view
  remove_access_role_scope_value :reader, :view, view
end

#remove_writer_domain(domain) ⇒ Object

Remove writer access from a domain.



251
252
253
 
# File 'lib/gcloud/bigquery/dataset/access.rb', line 251

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.



245
246
247
 
# File 'lib/gcloud/bigquery/dataset/access.rb', line 245

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



258
259
260
 
# File 'lib/gcloud/bigquery/dataset/access.rb', line 258

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.



239
240
241
 
# File 'lib/gcloud/bigquery/dataset/access.rb', line 239

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

#remove_writer_view(view) ⇒ Object

Remove writer access from a view. The view can be a Gcloud::Bigquery::View object, or a string identifier as specified by the [Query Reference](cloud.google.com/bigquery/query-reference#from): project_name:datasetId.tableId.



269
270
271
 
# File 'lib/gcloud/bigquery/dataset/access.rb', line 269

def remove_writer_view view
  remove_access_role_scope_value :writer, :view, view
end

#writer_domain?(domain) ⇒ Boolean

Checks writer access for a domain.

Returns:

  • (Boolean) 


359
360
361
 
# File 'lib/gcloud/bigquery/dataset/access.rb', line 359

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) 


353
354
355
 
# File 'lib/gcloud/bigquery/dataset/access.rb', line 353

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) 


366
367
368
 
# File 'lib/gcloud/bigquery/dataset/access.rb', line 366

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) 


347
348
349
 
# File 'lib/gcloud/bigquery/dataset/access.rb', line 347

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

#writer_view?(view) ⇒ Boolean

Checks writer access for a view. The view can be a Gcloud::Bigquery::View object, or a string identifier as specified by the [Query Reference](cloud.google.com/bigquery/query-reference#from): project_name:datasetId.tableId.

Returns:

  • (Boolean) 


377
378
379
 
# File 'lib/gcloud/bigquery/dataset/access.rb', line 377

def writer_view? view
  lookup_access_role_scope_value :writer, :view, view
end