Class: Google::Apis::AdminDirectoryV1::OrgUnit

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

Overview

Managing your account's organizational units allows you to configure your users' access to services and custom settings. For more information about common organizational unit tasks, see the Developer's Guide.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ OrgUnit

Returns a new instance of OrgUnit.



2514
2515
2516
 
# File 'lib/google/apis/admin_directory_v1/classes.rb', line 2514

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

Instance Attribute Details

#block_inheritance ⇒ Boolean Also known as: block_inheritance?

Determines if a sub-organizational unit can inherit the settings of the parent organization. The default value is false, meaning a sub-organizational unit inherits the settings of the nearest parent organizational unit. For more information on inheritance and users in an organization structure, see the administration help center. Corresponds to the JSON property blockInheritance

Returns:

  • (Boolean) 


2454
2455
2456
 
# File 'lib/google/apis/admin_directory_v1/classes.rb', line 2454

def block_inheritance
  @block_inheritance
end

#description ⇒ String

Description of the organizational unit. Corresponds to the JSON property description

Returns:

  • (String) 


2460
2461
2462
 
# File 'lib/google/apis/admin_directory_v1/classes.rb', line 2460

def description
  @description
end

#etag ⇒ String

ETag of the resource. Corresponds to the JSON property etag

Returns:

  • (String) 


2465
2466
2467
 
# File 'lib/google/apis/admin_directory_v1/classes.rb', line 2465

def etag
  @etag
end

#kind ⇒ String

The type of the API resource. For Orgunits resources, the value is admin# directory#orgUnit. Corresponds to the JSON property kind

Returns:

  • (String) 


2471
2472
2473
 
# File 'lib/google/apis/admin_directory_v1/classes.rb', line 2471

def kind
  @kind
end

#name ⇒ String

The organizational unit's path name. For example, an organizational unit's name within the /corp/support/sales_support parent path is sales_support. Required. Corresponds to the JSON property name

Returns:

  • (String) 


2478
2479
2480
 
# File 'lib/google/apis/admin_directory_v1/classes.rb', line 2478

def name
  @name
end

#org_unit_id ⇒ String

The unique ID of the organizational unit. Corresponds to the JSON property orgUnitId

Returns:

  • (String) 


2483
2484
2485
 
# File 'lib/google/apis/admin_directory_v1/classes.rb', line 2483

def org_unit_id
  @org_unit_id
end

#org_unit_path ⇒ String

The full path to the organizational unit. The orgUnitPath is a derived property. When listed, it is derived from parentOrgunitPath and organizational unit's name. For example, for an organizational unit named ' apps' under parent organization '/engineering', the orgUnitPath is '/ engineering/apps'. In order to edit an orgUnitPath, either update the name of the organization or the parentOrgunitPath. A user's organizational unit determines which Google Workspace services the user has access to. If the user is moved to a new organization, the user's access changes. For more information about organization structures, see the administration help center. For more information about moving a user to a different organization, see Update a user. Corresponds to the JSON property orgUnitPath

Returns:

  • (String) 


2499
2500
2501
 
# File 'lib/google/apis/admin_directory_v1/classes.rb', line 2499

def org_unit_path
  @org_unit_path
end

#parent_org_unit_id ⇒ String

The unique ID of the parent organizational unit. Required, unless parentOrgUnitPath is set. Corresponds to the JSON property parentOrgUnitId

Returns:

  • (String) 


2505
2506
2507
 
# File 'lib/google/apis/admin_directory_v1/classes.rb', line 2505

def parent_org_unit_id
  @parent_org_unit_id
end

#parent_org_unit_path ⇒ String

The organizational unit's parent path. For example, /corp/sales is the parent path for /corp/sales/sales_support organizational unit. Required, unless parentOrgUnitId is set. Corresponds to the JSON property parentOrgUnitPath

Returns:

  • (String) 


2512
2513
2514
 
# File 'lib/google/apis/admin_directory_v1/classes.rb', line 2512

def parent_org_unit_path
  @parent_org_unit_path
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



2519
2520
2521
2522
2523
2524
2525
2526
2527
2528
2529
 
# File 'lib/google/apis/admin_directory_v1/classes.rb', line 2519

def update!(**args)
  @block_inheritance = args[:block_inheritance] if args.key?(:block_inheritance)
  @description = args[:description] if args.key?(:description)
  @etag = args[:etag] if args.key?(:etag)
  @kind = args[:kind] if args.key?(:kind)
  @name = args[:name] if args.key?(:name)
  @org_unit_id = args[:org_unit_id] if args.key?(:org_unit_id)
  @org_unit_path = args[:org_unit_path] if args.key?(:org_unit_path)
  @parent_org_unit_id = args[:parent_org_unit_id] if args.key?(:parent_org_unit_id)
  @parent_org_unit_path = args[:parent_org_unit_path] if args.key?(:parent_org_unit_path)
end