Class: Google::Cloud::ResourceManager::Manager

Inherits:
Object
  • Object
show all
Defined in:
lib/google/cloud/resource_manager/manager.rb

Overview

Manager

Provides methods for creating, retrieving, and updating projects.

See Google::Cloud#resource_manager

Examples:

require "google/cloud"

gcloud = Google::Cloud.new
resource_manager = gcloud.resource_manager
resource_manager.projects.each do |project|
  puts projects.project_id
end

Instance Method Summary collapse

Instance Method Details

#create_project(project_id, name: nil, labels: nil) ⇒ Google::Cloud::ResourceManager::Project

Creates a project resource.

Initially, the project resource is owned by its creator exclusively. The creator can later grant permission to others to read or update the project.

Several APIs are activated automatically for the project, including Google Cloud Storage.

Examples:

require "google/cloud"

gcloud = Google::Cloud.new
resource_manager = gcloud.resource_manager
project = resource_manager.create_project "tokyo-rain-123"

A project can also be created with a name and labels:

require "google/cloud"

gcloud = Google::Cloud.new
resource_manager = gcloud.resource_manager
project = resource_manager.create_project "tokyo-rain-123",
  name: "Todos Development", labels: {env: :development}

Parameters:

  • project_id (String) —

    The unique, user-assigned ID of the project. It must be 6 to 30 lowercase letters, digits, or hyphens. It must start with a letter. Trailing hyphens are prohibited.

  • name (String) —

    The user-assigned name of the project. This field is optional and can remain unset.

    Allowed characters are: lowercase and uppercase letters, numbers, hyphen, single-quote, double-quote, space, and exclamation point.

  • labels (Hash) —

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

    Label values must be between 0 and 63 characters long and must conform to the regular expression (a-z?)?.

    No more than 256 labels can be associated with a given resource.

Returns:



192
193
194
195
 
# File 'lib/google/cloud/resource_manager/manager.rb', line 192

def create_project project_id, name: nil, labels: nil
  gapi = service.create_project project_id, name, labels
  Project.from_gapi gapi, service
end

#delete(project_id) ⇒ Object

Marks the project for deletion. This method will only affect the project if the following criteria are met:

  • The project does not have a billing account associated with it.
  • The project has a lifecycle state of ACTIVE.
  • This method changes the project's lifecycle state from ACTIVE to DELETE_REQUESTED. The deletion starts at an unspecified time, at which point the lifecycle state changes to DELETE_IN_PROGRESS.

Until the deletion completes, you can check the lifecycle state by retrieving the project with Manager#project. The project remains visible to Manager#project and Manager#projects, but cannot be updated.

After the deletion completes, the project is not retrievable by the Manager#project and Manager#projects methods.

The caller must have modify permissions for this project.

Examples:

require "google/cloud"

gcloud = Google::Cloud.new
resource_manager = gcloud.resource_manager
resource_manager.delete "tokyo-rain-123"

Parameters:

  • project_id (String) —

    The ID of the project.



226
227
228
229
 
# File 'lib/google/cloud/resource_manager/manager.rb', line 226

def delete project_id
  service.delete_project project_id
  true
end

#project(project_id) ⇒ Google::Cloud::ResourceManager::Project?

Retrieves the project identified by the specified project_id.

Examples:

require "google/cloud"

gcloud = Google::Cloud.new
resource_manager = gcloud.resource_manager
project = resource_manager.project "tokyo-rain-123"
project.project_id #=> "tokyo-rain-123"

Parameters:

  • project_id (String) —

    The ID of the project.

Returns:



138
139
140
141
142
143
 
# File 'lib/google/cloud/resource_manager/manager.rb', line 138

def project project_id
  gapi = service.get_project project_id
  Project.from_gapi gapi, service
rescue NotFoundError
  nil
end

#projects(filter: nil, token: nil, max: nil) ⇒ Array<Google::Cloud::ResourceManager::Project>

Retrieves the projects that are visible to the user and satisfy the specified filter. This method returns projects in an unspecified order. New projects do not necessarily appear at the end of the list.

Examples:

require "google/cloud"

gcloud = Google::Cloud.new
resource_manager = gcloud.resource_manager
projects = resource_manager.projects

projects.each do |project|
  puts project.project_id
end

Projects can be filtered using the filter option:

require "google/cloud"

gcloud = Google::Cloud.new
resource_manager = gcloud.resource_manager
projects = resource_manager.projects filter: "labels.env:production"

projects.each do |project|
  puts project.project_id
end

Retrieve all projects: (See Project::List#all)

require "google/cloud"

gcloud = Google::Cloud.new
resource_manager = gcloud.resource_manager
projects = resource_manager.projects

projects.all do |project|
  puts project.project_id
end

Parameters:

  • filter (String) —

    An expression for filtering the results of the request. Filter rules are case insensitive.

    The fields eligible for filtering are:

    • name
    • id
    • labels.key - where key is the name of a label

    Some examples of using labels as filters:

    • name:* - The project has a name.
    • name:Howl - The project's name is Howl or howl.
    • name:HOWL - Equivalent to above.
    • NAME:howl - Equivalent to above.
    • labels.color:* - The project has the label color.
    • labels.color:red - The project's label color has the value red.
    • labels.color:red labels.size:big - The project's label color has the value red and its label size has the value big.
  • token (String) —

    A previously-returned page token representing part of the larger set of results to view.

  • max (Integer) —

    Maximum number of projects to return.

Returns:



117
118
119
120
 
# File 'lib/google/cloud/resource_manager/manager.rb', line 117

def projects filter: nil, token: nil, max: nil
  gapi = service.list_project filter: filter, token: token, max: max
  Project::List.from_gapi gapi, self, filter, max
end

#undelete(project_id) ⇒ Object

Restores the project. You can only use this method for a project that has a lifecycle state of DELETE_REQUESTED. After deletion starts, as indicated by a lifecycle state of DELETE_IN_PROGRESS, the project cannot be restored.

The caller must have modify permissions for this project.

Examples:

require "google/cloud"

gcloud = Google::Cloud.new
resource_manager = gcloud.resource_manager
resource_manager.undelete "tokyo-rain-123"

Parameters:

  • project_id (String) —

    The ID of the project.



248
249
250
251
 
# File 'lib/google/cloud/resource_manager/manager.rb', line 248

def undelete project_id
  service.undelete_project project_id
  true
end