Cloud Resource Manager API - Module Google::Cloud::ResourceManager (v1.0.0)

Reference documentation and code samples for the Cloud Resource Manager API module Google::Cloud::ResourceManager.

Methods

.configure

def self.configure() -> ::Google::Cloud::Config

Configure the google-cloud-resource_manager library.

The following configuration parameters are supported:

  • credentials (type: 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.
  • lib_name (type: String) - The library name as recorded in instrumentation and logging.
  • lib_version (type: String) - The library version as recorded in instrumentation and logging.
  • interceptors (type: Array<GRPC::ClientInterceptor>) - An array of interceptors that are run before calls are executed.
  • timeout (type: Numeric) - Default timeout in seconds.
  • metadata (type: Hash{Symbol=>String}) - Additional headers to be sent with the call.
  • retry_policy (type: Hash) - The retry policy. The value is a hash with the following keys:
    • :initial_delay (type: Numeric) - The initial delay in seconds.
    • :max_delay (type: Numeric) - The max delay in seconds.
    • :multiplier (type: Numeric) - The incremental backoff multiplier.
    • :retry_codes (type: Array<String>) - The error codes that should trigger a retry.
Yields
  • (::Google::Cloud.configure.resource_manager)
Returns
  • (::Google::Cloud::Config) — The default configuration used by this library

.folders

def self.folders(version: :v3, transport: :grpc, &block) -> ::Object

Create a new client object for Folders.

By default, this returns an instance of Google::Cloud::ResourceManager::V3::Folders::Client for a gRPC client for version V3 of the API. However, you can specify a different API version by passing it in the version parameter. If the Folders service is supported by that API version, and the corresponding gem is available, the appropriate versioned client will be returned. You can also specify a different transport by passing :rest or :grpc in the transport parameter.

Raises an exception if the currently installed versioned client gem for the given API version does not support the given transport of the Folders service. You can determine whether the method will succeed by calling ResourceManager.folders_available?.

About Folders

Manages Cloud Platform folder resources. Folders can be used to organize the resources under an organization and to control the policies applied to groups of resources.

Parameters
  • version (::String, ::Symbol) (defaults to: :v3) — The API version to connect to. Optional. Defaults to :v3.
  • transport (:grpc, :rest) (defaults to: :grpc) — The transport to use. Defaults to :grpc.
Returns
  • (::Object) — A client object for the specified version.

.folders_available?

def self.folders_available?(version: :v3, transport: :grpc) -> boolean

Determines whether the Folders service is supported by the current client. If true, you can retrieve a client object by calling ResourceManager.folders. If false, that method will raise an exception. This could happen if the given API version does not exist or does not support the Folders service, or if the versioned client gem needs an update to support the Folders service.

Parameters
  • version (::String, ::Symbol) (defaults to: :v3) — The API version to connect to. Optional. Defaults to :v3.
  • transport (:grpc, :rest) (defaults to: :grpc) — The transport to use. Defaults to :grpc.
Returns
  • (boolean) — Whether the service is available.

.organizations

def self.organizations(version: :v3, transport: :grpc, &block) -> ::Object

Create a new client object for Organizations.

By default, this returns an instance of Google::Cloud::ResourceManager::V3::Organizations::Client for a gRPC client for version V3 of the API. However, you can specify a different API version by passing it in the version parameter. If the Organizations service is supported by that API version, and the corresponding gem is available, the appropriate versioned client will be returned. You can also specify a different transport by passing :rest or :grpc in the transport parameter.

Raises an exception if the currently installed versioned client gem for the given API version does not support the given transport of the Organizations service. You can determine whether the method will succeed by calling ResourceManager.organizations_available?.

About Organizations

Allows users to manage their organization resources.

Parameters
  • version (::String, ::Symbol) (defaults to: :v3) — The API version to connect to. Optional. Defaults to :v3.
  • transport (:grpc, :rest) (defaults to: :grpc) — The transport to use. Defaults to :grpc.
Returns
  • (::Object) — A client object for the specified version.

.organizations_available?

def self.organizations_available?(version: :v3, transport: :grpc) -> boolean

Determines whether the Organizations service is supported by the current client. If true, you can retrieve a client object by calling ResourceManager.organizations. If false, that method will raise an exception. This could happen if the given API version does not exist or does not support the Organizations service, or if the versioned client gem needs an update to support the Organizations service.

Parameters
  • version (::String, ::Symbol) (defaults to: :v3) — The API version to connect to. Optional. Defaults to :v3.
  • transport (:grpc, :rest) (defaults to: :grpc) — The transport to use. Defaults to :grpc.
Returns
  • (boolean) — Whether the service is available.

.projects

def self.projects(version: :v3, transport: :grpc, &block) -> ::Object

Create a new client object for Projects.

By default, this returns an instance of Google::Cloud::ResourceManager::V3::Projects::Client for a gRPC client for version V3 of the API. However, you can specify a different API version by passing it in the version parameter. If the Projects service is supported by that API version, and the corresponding gem is available, the appropriate versioned client will be returned. You can also specify a different transport by passing :rest or :grpc in the transport parameter.

Raises an exception if the currently installed versioned client gem for the given API version does not support the given transport of the Projects service. You can determine whether the method will succeed by calling ResourceManager.projects_available?.

About Projects

Manages Google Cloud Projects.

Parameters
  • version (::String, ::Symbol) (defaults to: :v3) — The API version to connect to. Optional. Defaults to :v3.
  • transport (:grpc, :rest) (defaults to: :grpc) — The transport to use. Defaults to :grpc.
Returns
  • (::Object) — A client object for the specified version.

.projects_available?

def self.projects_available?(version: :v3, transport: :grpc) -> boolean

Determines whether the Projects service is supported by the current client. If true, you can retrieve a client object by calling ResourceManager.projects. If false, that method will raise an exception. This could happen if the given API version does not exist or does not support the Projects service, or if the versioned client gem needs an update to support the Projects service.

Parameters
  • version (::String, ::Symbol) (defaults to: :v3) — The API version to connect to. Optional. Defaults to :v3.
  • transport (:grpc, :rest) (defaults to: :grpc) — The transport to use. Defaults to :grpc.
Returns
  • (boolean) — Whether the service is available.

.tag_bindings

def self.tag_bindings(version: :v3, transport: :grpc, &block) -> ::Object

Create a new client object for TagBindings.

By default, this returns an instance of Google::Cloud::ResourceManager::V3::TagBindings::Client for a gRPC client for version V3 of the API. However, you can specify a different API version by passing it in the version parameter. If the TagBindings service is supported by that API version, and the corresponding gem is available, the appropriate versioned client will be returned. You can also specify a different transport by passing :rest or :grpc in the transport parameter.

Raises an exception if the currently installed versioned client gem for the given API version does not support the given transport of the TagBindings service. You can determine whether the method will succeed by calling ResourceManager.tag_bindings_available?.

About TagBindings

Allow users to create and manage TagBindings between TagValues and different Google Cloud resources throughout the GCP resource hierarchy.

Parameters
  • version (::String, ::Symbol) (defaults to: :v3) — The API version to connect to. Optional. Defaults to :v3.
  • transport (:grpc, :rest) (defaults to: :grpc) — The transport to use. Defaults to :grpc.
Returns
  • (::Object) — A client object for the specified version.

.tag_bindings_available?

def self.tag_bindings_available?(version: :v3, transport: :grpc) -> boolean

Determines whether the TagBindings service is supported by the current client. If true, you can retrieve a client object by calling ResourceManager.tag_bindings. If false, that method will raise an exception. This could happen if the given API version does not exist or does not support the TagBindings service, or if the versioned client gem needs an update to support the TagBindings service.

Parameters
  • version (::String, ::Symbol) (defaults to: :v3) — The API version to connect to. Optional. Defaults to :v3.
  • transport (:grpc, :rest) (defaults to: :grpc) — The transport to use. Defaults to :grpc.
Returns
  • (boolean) — Whether the service is available.

.tag_holds

def self.tag_holds(version: :v3, transport: :grpc, &block) -> ::Object

Create a new client object for TagHolds.

By default, this returns an instance of Google::Cloud::ResourceManager::V3::TagHolds::Client for a gRPC client for version V3 of the API. However, you can specify a different API version by passing it in the version parameter. If the TagHolds service is supported by that API version, and the corresponding gem is available, the appropriate versioned client will be returned. You can also specify a different transport by passing :rest or :grpc in the transport parameter.

Raises an exception if the currently installed versioned client gem for the given API version does not support the given transport of the TagHolds service. You can determine whether the method will succeed by calling ResourceManager.tag_holds_available?.

About TagHolds

Allow users to create and manage TagHolds for TagValues. TagHolds represent the use of a Tag Value that is not captured by TagBindings but should still block TagValue deletion (such as a reference in a policy condition). This service provides isolated failure domains by cloud location so that TagHolds can be managed in the same location as their usage.

Parameters
  • version (::String, ::Symbol) (defaults to: :v3) — The API version to connect to. Optional. Defaults to :v3.
  • transport (:grpc, :rest) (defaults to: :grpc) — The transport to use. Defaults to :grpc.
Returns
  • (::Object) — A client object for the specified version.

.tag_holds_available?

def self.tag_holds_available?(version: :v3, transport: :grpc) -> boolean

Determines whether the TagHolds service is supported by the current client. If true, you can retrieve a client object by calling ResourceManager.tag_holds. If false, that method will raise an exception. This could happen if the given API version does not exist or does not support the TagHolds service, or if the versioned client gem needs an update to support the TagHolds service.

Parameters
  • version (::String, ::Symbol) (defaults to: :v3) — The API version to connect to. Optional. Defaults to :v3.
  • transport (:grpc, :rest) (defaults to: :grpc) — The transport to use. Defaults to :grpc.
Returns
  • (boolean) — Whether the service is available.

.tag_keys

def self.tag_keys(version: :v3, transport: :grpc, &block) -> ::Object

Create a new client object for TagKeys.

By default, this returns an instance of Google::Cloud::ResourceManager::V3::TagKeys::Client for a gRPC client for version V3 of the API. However, you can specify a different API version by passing it in the version parameter. If the TagKeys service is supported by that API version, and the corresponding gem is available, the appropriate versioned client will be returned. You can also specify a different transport by passing :rest or :grpc in the transport parameter.

Raises an exception if the currently installed versioned client gem for the given API version does not support the given transport of the TagKeys service. You can determine whether the method will succeed by calling ResourceManager.tag_keys_available?.

About TagKeys

Allow users to create and manage tag keys.

Parameters
  • version (::String, ::Symbol) (defaults to: :v3) — The API version to connect to. Optional. Defaults to :v3.
  • transport (:grpc, :rest) (defaults to: :grpc) — The transport to use. Defaults to :grpc.
Returns
  • (::Object) — A client object for the specified version.

.tag_keys_available?

def self.tag_keys_available?(version: :v3, transport: :grpc) -> boolean

Determines whether the TagKeys service is supported by the current client. If true, you can retrieve a client object by calling ResourceManager.tag_keys. If false, that method will raise an exception. This could happen if the given API version does not exist or does not support the TagKeys service, or if the versioned client gem needs an update to support the TagKeys service.

Parameters
  • version (::String, ::Symbol) (defaults to: :v3) — The API version to connect to. Optional. Defaults to :v3.
  • transport (:grpc, :rest) (defaults to: :grpc) — The transport to use. Defaults to :grpc.
Returns
  • (boolean) — Whether the service is available.

.tag_values

def self.tag_values(version: :v3, transport: :grpc, &block) -> ::Object

Create a new client object for TagValues.

By default, this returns an instance of Google::Cloud::ResourceManager::V3::TagValues::Client for a gRPC client for version V3 of the API. However, you can specify a different API version by passing it in the version parameter. If the TagValues service is supported by that API version, and the corresponding gem is available, the appropriate versioned client will be returned. You can also specify a different transport by passing :rest or :grpc in the transport parameter.

Raises an exception if the currently installed versioned client gem for the given API version does not support the given transport of the TagValues service. You can determine whether the method will succeed by calling ResourceManager.tag_values_available?.

About TagValues

Allow users to create and manage tag values.

Parameters
  • version (::String, ::Symbol) (defaults to: :v3) — The API version to connect to. Optional. Defaults to :v3.
  • transport (:grpc, :rest) (defaults to: :grpc) — The transport to use. Defaults to :grpc.
Returns
  • (::Object) — A client object for the specified version.

.tag_values_available?

def self.tag_values_available?(version: :v3, transport: :grpc) -> boolean

Determines whether the TagValues service is supported by the current client. If true, you can retrieve a client object by calling ResourceManager.tag_values. If false, that method will raise an exception. This could happen if the given API version does not exist or does not support the TagValues service, or if the versioned client gem needs an update to support the TagValues service.

Parameters
  • version (::String, ::Symbol) (defaults to: :v3) — The API version to connect to. Optional. Defaults to :v3.
  • transport (:grpc, :rest) (defaults to: :grpc) — The transport to use. Defaults to :grpc.
Returns
  • (boolean) — Whether the service is available.

Constants

VERSION

value: "1.0.0"