Class: Google::Apis::CloudresourcemanagerV3::Project

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 project is a high-level Google Cloud entity. It is a container for ACLs, APIs, App Engine Apps, VMs, and other Google Cloud Platform resources.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ Project

Returns a new instance of Project.



1543
1544
1545
 
# File 'lib/google/apis/cloudresourcemanager_v3/classes.rb', line 1543

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

Instance Attribute Details

#configured_capabilities ⇒ Array<String>

Output only. If this project is a Management Project, list of capabilities configured on the parent folder. Note, presence of any capability implies that this is a Management Project. Example: folders/123/capabilities/app- management. OUTPUT ONLY. Corresponds to the JSON property configuredCapabilities

Returns:

  • (Array<String>) 


1467
1468
1469
 
# File 'lib/google/apis/cloudresourcemanager_v3/classes.rb', line 1467

def configured_capabilities
  @configured_capabilities
end

#create_time ⇒ String

Output only. Creation time. Corresponds to the JSON property createTime

Returns:

  • (String) 


1472
1473
1474
 
# File 'lib/google/apis/cloudresourcemanager_v3/classes.rb', line 1472

def create_time
  @create_time
end

#delete_time ⇒ String

Output only. The time at which this resource was requested for deletion. Corresponds to the JSON property deleteTime

Returns:

  • (String) 


1477
1478
1479
 
# File 'lib/google/apis/cloudresourcemanager_v3/classes.rb', line 1477

def delete_time
  @delete_time
end

#display_name ⇒ String

Optional. A user-assigned display name of the project. When present it must be between 4 to 30 characters. Allowed characters are: lowercase and uppercase letters, numbers, hyphen, single-quote, double-quote, space, and exclamation point. Example: My Project Corresponds to the JSON property displayName

Returns:

  • (String) 


1485
1486
1487
 
# File 'lib/google/apis/cloudresourcemanager_v3/classes.rb', line 1485

def display_name
  @display_name
end

#etag ⇒ String

Output only. A checksum computed by the server based on the current value of the Project 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) 


1492
1493
1494
 
# File 'lib/google/apis/cloudresourcemanager_v3/classes.rb', line 1492

def etag
  @etag
end

#labels ⇒ Hash<String,String>

Optional. The labels associated with this project. Label keys must be between 1 and 63 characters long and must conform to the following regular expression: [a-z]([-a-z0-9]*[a-z0-9])?. Label values must be between 0 and 63 characters long and must conform to the regular expression ([a-z]([-a-z0-9] *[a-z0-9])?)?. No more than 64 labels can be associated with a given resource. Clients should store labels in a representation such as JSON that does not depend on specific characters being disallowed. Example: " myBusinessDimension" : "businessValue" Corresponds to the JSON property labels

Returns:

  • (Hash<String,String>) 


1504
1505
1506
 
# File 'lib/google/apis/cloudresourcemanager_v3/classes.rb', line 1504

def labels
  @labels
end

#name ⇒ String

Output only. The unique resource name of the project. It is an int64 generated number prefixed by "projects/". Example: projects/415104041262 Corresponds to the JSON property name

Returns:

  • (String) 


1510
1511
1512
 
# File 'lib/google/apis/cloudresourcemanager_v3/classes.rb', line 1510

def name
  @name
end

#parent ⇒ String

Optional. A reference to a parent Resource. eg., organizations/123 or folders/876. Corresponds to the JSON property parent

Returns:

  • (String) 


1516
1517
1518
 
# File 'lib/google/apis/cloudresourcemanager_v3/classes.rb', line 1516

def parent
  @parent
end

#project_id ⇒ String

Immutable. The unique, user-assigned id of the project. It must be 6 to 30 lowercase ASCII letters, digits, or hyphens. It must start with a letter. Trailing hyphens are prohibited. Example: tokyo-rain-123 Corresponds to the JSON property projectId

Returns:

  • (String) 


1523
1524
1525
 
# File 'lib/google/apis/cloudresourcemanager_v3/classes.rb', line 1523

def project_id
  @project_id
end

#state ⇒ String

Output only. The project lifecycle state. Corresponds to the JSON property state

Returns:

  • (String) 


1528
1529
1530
 
# File 'lib/google/apis/cloudresourcemanager_v3/classes.rb', line 1528

def state
  @state
end

#tags ⇒ Hash<String,String>

Optional. Input only. Immutable. Tag keys/values directly bound to this project. Each item in the map must be expressed as " : ". For example: "123/ environment" : "production", "123/costCenter" : "marketing" Note: Currently this field is in Preview. Corresponds to the JSON property tags

Returns:

  • (Hash<String,String>) 


1536
1537
1538
 
# File 'lib/google/apis/cloudresourcemanager_v3/classes.rb', line 1536

def tags
  @tags
end

#update_time ⇒ String

Output only. The most recent time this resource was modified. Corresponds to the JSON property updateTime

Returns:

  • (String) 


1541
1542
1543
 
# File 'lib/google/apis/cloudresourcemanager_v3/classes.rb', line 1541

def update_time
  @update_time
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



1548
1549
1550
1551
1552
1553
1554
1555
1556
1557
1558
1559
1560
1561
 
# File 'lib/google/apis/cloudresourcemanager_v3/classes.rb', line 1548

def update!(**args)
  @configured_capabilities = args[:configured_capabilities] if args.key?(:configured_capabilities)
  @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)
  @labels = args[:labels] if args.key?(:labels)
  @name = args[:name] if args.key?(:name)
  @parent = args[:parent] if args.key?(:parent)
  @project_id = args[:project_id] if args.key?(:project_id)
  @state = args[:state] if args.key?(:state)
  @tags = args[:tags] if args.key?(:tags)
  @update_time = args[:update_time] if args.key?(:update_time)
end