Class: Google::Apis::BigqueryV2::Dataset::Access

Inherits:
Object
  • Object
show all
Includes:
Core::Hashable, Core::JsonObjectSupport
Defined in:
lib/google/apis/bigquery_v2/classes.rb,
lib/google/apis/bigquery_v2/representations.rb,
lib/google/apis/bigquery_v2/representations.rb

Overview

An object that defines dataset access for an entity.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ Access

Returns a new instance of Access.



2033
2034
2035
 
# File 'lib/google/apis/bigquery_v2/classes.rb', line 2033

def initialize(**args)
   update!(**args)
end

Instance Attribute Details

#dataset ⇒ Google::Apis::BigqueryV2::DatasetAccessEntry

Grants all resources of particular types in a particular dataset read access to the current dataset. Similar to how individually authorized views work, updates to any resource granted through its dataset (including creation of new resources) requires read permission to referenced resources, plus write permission to the authorizing dataset. Corresponds to the JSON property dataset

Returns:



1973
1974
1975
 
# File 'lib/google/apis/bigquery_v2/classes.rb', line 1973

def dataset
  @dataset
end

#domain ⇒ String

[Pick one] A domain to grant access to. Any users signed in with the domain specified will be granted the specified access. Example: "example.com". Maps to IAM policy member "domain:DOMAIN". Corresponds to the JSON property domain

Returns:

  • (String) 


1980
1981
1982
 
# File 'lib/google/apis/bigquery_v2/classes.rb', line 1980

def domain
  @domain
end

#group_by_email ⇒ String

[Pick one] An email address of a Google Group to grant access to. Maps to IAM policy member "group:GROUP". Corresponds to the JSON property groupByEmail

Returns:

  • (String) 


1986
1987
1988
 
# File 'lib/google/apis/bigquery_v2/classes.rb', line 1986

def group_by_email
  @group_by_email
end

#iam_member ⇒ String

[Pick one] Some other type of member that appears in the IAM Policy but isn't a user, group, domain, or special group. Corresponds to the JSON property iamMember

Returns:

  • (String) 


1992
1993
1994
 
# File 'lib/google/apis/bigquery_v2/classes.rb', line 1992

def iam_member
  @iam_member
end

#role ⇒ String

An IAM role ID that should be granted to the user, group, or domain specified in this access entry. The following legacy mappings will be applied: OWNER <=> roles/bigquery.dataOwner WRITER <=> roles/bigquery.dataEditor READER <=> roles/ bigquery.dataViewer This field will accept any of the above formats, but will return only the legacy format. For example, if you set this field to "roles/ bigquery.dataOwner", it will be returned back as "OWNER". Corresponds to the JSON property role

Returns:

  • (String) 


2002
2003
2004
 
# File 'lib/google/apis/bigquery_v2/classes.rb', line 2002

def role
  @role
end

#routine ⇒ Google::Apis::BigqueryV2::RoutineReference

Id path of a routine. Corresponds to the JSON property routine

Returns:



2007
2008
2009
 
# File 'lib/google/apis/bigquery_v2/classes.rb', line 2007

def routine
  @routine
end

#special_group ⇒ String

[Pick one] A special group to grant access to. Possible values include: projectOwners: Owners of the enclosing project. projectReaders: Readers of the enclosing project. projectWriters: Writers of the enclosing project. allAuthenticatedUsers: All authenticated BigQuery users. Maps to similarly- named IAM members. Corresponds to the JSON property specialGroup

Returns:

  • (String) 


2016
2017
2018
 
# File 'lib/google/apis/bigquery_v2/classes.rb', line 2016

def special_group
  @special_group
end

#user_by_email ⇒ String

[Pick one] An email address of a user to grant access to. For example: fred@ example.com. Maps to IAM policy member "user:EMAIL" or "serviceAccount:EMAIL". Corresponds to the JSON property userByEmail

Returns:

  • (String) 


2022
2023
2024
 
# File 'lib/google/apis/bigquery_v2/classes.rb', line 2022

def user_by_email
  @user_by_email
end

#view ⇒ Google::Apis::BigqueryV2::TableReference

[Pick one] A view from a different dataset to grant access to. Queries executed against that view will have read access to views/tables/routines in this dataset. The role field is not required when this field is set. If that view is updated by any user, access to the view needs to be granted again via an update operation. Corresponds to the JSON property view

Returns:



2031
2032
2033
 
# File 'lib/google/apis/bigquery_v2/classes.rb', line 2031

def view
  @view
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



2038
2039
2040
2041
2042
2043
2044
2045
2046
2047
2048
 
# File 'lib/google/apis/bigquery_v2/classes.rb', line 2038

def update!(**args)
  @dataset = args[:dataset] if args.key?(:dataset)
  @domain = args[:domain] if args.key?(:domain)
  @group_by_email = args[:group_by_email] if args.key?(:group_by_email)
  @iam_member = args[:iam_member] if args.key?(:iam_member)
  @role = args[:role] if args.key?(:role)
  @routine = args[:routine] if args.key?(:routine)
  @special_group = args[:special_group] if args.key?(:special_group)
  @user_by_email = args[:user_by_email] if args.key?(:user_by_email)
  @view = args[:view] if args.key?(:view)
end