Class: Google::Apis::CloudresourcemanagerV3::Folder

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

Overview

A Folder in an Organization's resource hierarchy, used to organize that Organization's resources.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ Folder

Returns a new instance of Folder.



527
528
529
 
# File 'lib/google/apis/cloudresourcemanager_v3/classes.rb', line 527

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

Instance Attribute Details

#create_time ⇒ String

Output only. Timestamp when the Folder was created. Corresponds to the JSON property createTime

Returns:

  • (String) 


480
481
482
 
# File 'lib/google/apis/cloudresourcemanager_v3/classes.rb', line 480

def create_time
  @create_time
end

#delete_time ⇒ String

Output only. Timestamp when the Folder was requested to be deleted. Corresponds to the JSON property deleteTime

Returns:

  • (String) 


485
486
487
 
# File 'lib/google/apis/cloudresourcemanager_v3/classes.rb', line 485

def delete_time
  @delete_time
end

#display_name ⇒ String

The folder's display name. A folder's display name must be unique amongst its siblings, e.g. no two folders with the same parent can share the same display name. The display name must start and end with a letter or digit, may contain letters, digits, spaces, hyphens and underscores and can be no longer than 30 characters. This is captured by the regular expression: [\pL\pN]([\pL\p N_- ]0,28[\pL\pN])?. Corresponds to the JSON property displayName

Returns:

  • (String) 


495
496
497
 
# File 'lib/google/apis/cloudresourcemanager_v3/classes.rb', line 495

def display_name
  @display_name
end

#etag ⇒ String

Output only. A checksum computed by the server based on the current value of the Folder resource. This may be sent on update and delete requests to ensure the client has an up-to-date value before proceeding. Corresponds to the JSON property etag

Returns:

  • (String) 


502
503
504
 
# File 'lib/google/apis/cloudresourcemanager_v3/classes.rb', line 502

def etag
  @etag
end

#name ⇒ String

Output only. The resource name of the Folder. Its format is folders/ folder_id`, for example: "folders/1234". Corresponds to the JSON propertyname`

Returns:

  • (String) 


508
509
510
 
# File 'lib/google/apis/cloudresourcemanager_v3/classes.rb', line 508

def name
  @name
end

#parent ⇒ String

Required. The Folder's parent's resource name. Updates to the folder's parent must be performed via MoveFolder. Corresponds to the JSON property parent

Returns:

  • (String) 


514
515
516
 
# File 'lib/google/apis/cloudresourcemanager_v3/classes.rb', line 514

def parent
  @parent
end

#state ⇒ String

Output only. The lifecycle state of the folder. Updates to the state must be performed via DeleteFolder and UndeleteFolder. Corresponds to the JSON property state

Returns:

  • (String) 


520
521
522
 
# File 'lib/google/apis/cloudresourcemanager_v3/classes.rb', line 520

def state
  @state
end

#update_time ⇒ String

Output only. Timestamp when the Folder was last modified. Corresponds to the JSON property updateTime

Returns:

  • (String) 


525
526
527
 
# File 'lib/google/apis/cloudresourcemanager_v3/classes.rb', line 525

def update_time
  @update_time
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



532
533
534
535
536
537
538
539
540
541
 
# File 'lib/google/apis/cloudresourcemanager_v3/classes.rb', line 532

def update!(**args)
  @create_time = args[:create_time] if args.key?(:create_time)
  @delete_time = args[:delete_time] if args.key?(:delete_time)
  @display_name = args[:display_name] if args.key?(:display_name)
  @etag = args[:etag] if args.key?(:etag)
  @name = args[:name] if args.key?(:name)
  @parent = args[:parent] if args.key?(:parent)
  @state = args[:state] if args.key?(:state)
  @update_time = args[:update_time] if args.key?(:update_time)
end