module Google::Cloud::ResourceManager
# Google
Cloud
Resource
Manager
The Resource
Manager
API provides methods that you can use to programmatically manage your projects in the Google
Cloud
Platform.
Constants
- VERSION
Public Class Methods
Configure the Google
Cloud
Resource
Manager
library.
The following Resource
Manager
configuration parameters are supported:
-
`credentials` - (String, Hash, Google::Auth::Credentials) The path to the keyfile as a String, the contents of the keyfile as a Hash, or a Google::Auth::Credentials object. (See {ResourceManager::Credentials}) (The parameter `keyfile` is also available but deprecated.)
-
`scope` - (String, Array<String>) The OAuth 2.0 scopes controlling the set of resources and operations that the connection can access.
-
`retries` - (Integer) Number of times to retry requests on server error.
-
`timeout` - (Integer) Default timeout to use in requests.
@return [Google::Cloud::Config] The configuration object the
Google::Cloud::ResourceManager library uses.
# File lib/google/cloud/resource_manager.rb, line 106 def self.configure yield Google::Cloud.configure.resource_manager if block_given? Google::Cloud.configure.resource_manager end
@private Default credentials.
# File lib/google/cloud/resource_manager.rb, line 114 def self.default_credentials scope: nil Google::Cloud.configure.resource_manager.credentials || Google::Cloud.configure.credentials || ResourceManager::Credentials.default(scope: scope) end
Creates a new `Project` instance connected to the Resource
Manager
service. Each call creates a new connection.
For more information on connecting to Google
Cloud
see the {file:AUTHENTICATION.md Authentication Guide}.
@param [String, Hash, Google::Auth::Credentials] credentials The path to
the keyfile as a String, the contents of the keyfile as a Hash, or a Google::Auth::Credentials object. (See {ResourceManager::Credentials})
@param [String, Array<String>] scope The OAuth 2.0 scopes controlling
the set of resources and operations that the connection can access. See [Using OAuth 2.0 to Access Google APIs](https://developers.google.com/identity/protocols/OAuth2). The default scope is: * `https://www.googleapis.com/auth/cloud-platform`
@param [Integer] retries Number of times to retry requests on server
error. The default value is `3`. Optional.
@param [Integer] timeout Default timeout to use in requests. Optional. @param [String] endpoint Override of the endpoint host name. Optional.
If the param is nil, uses the default endpoint.
@param [String] keyfile Alias for the `credentials` argument.
Deprecated.
@return [Google::Cloud::ResourceManager::Manager]
@example
require "google/cloud/resource_manager" resource_manager = Google::Cloud::ResourceManager.new resource_manager.projects.each do |project| puts projects.project_id end
# File lib/google/cloud/resource_manager.rb, line 68 def self.new credentials: nil, scope: nil, retries: nil, timeout: nil, endpoint: nil, keyfile: nil scope ||= configure.scope retries ||= configure.retries timeout ||= configure.timeout endpoint ||= configure.endpoint credentials ||= keyfile credentials ||= default_credentials scope: scope unless credentials.is_a? Google::Auth::Credentials credentials = ResourceManager::Credentials.new credentials, scope: scope end ResourceManager::Manager.new( ResourceManager::Service.new( credentials, retries: retries, timeout: timeout, host: endpoint, quota_project: configure.quota_project ) ) end