module Google::Cloud::ManagedIdentities
Constants
- VERSION
Public Class Methods
Configure the google-cloud-managed_identities 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 gRPC 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.
@return [::Google::Cloud::Config] The default configuration used by this library
# File lib/google/cloud/managed_identities.rb, line 136 def self.configure yield ::Google::Cloud.configure.managed_identities if block_given? ::Google::Cloud.configure.managed_identities end
Create a new client object for ManagedIdentitiesService.
By default, this returns an instance of [Google::Cloud::ManagedIdentities::V1::ManagedIdentitiesService::Client](googleapis.dev/ruby/google-cloud-managed_identities-v1/latest/Google/Cloud/ManagedIdentities/V1/ManagedIdentitiesService/Client.html) for version V1 of the API. However, you can specify specify a different API version by passing it in the `version` parameter. If the ManagedIdentitiesService service is supported by that API version, and the corresponding gem is available, the appropriate versioned client will be returned.
## About ManagedIdentitiesService
API Overview
The `managedidentites.googleapis.com` service implements the Google
Cloud
Managed Identites API for identity services (e.g. Microsoft Active Directory).
The Managed Identities service provides methods to manage (create/read/update/delete) domains, reset managed identities admin password, add/remove domain controllers in GCP regions and add/remove VPC peering.
Data Model
The Managed Identities service exposes the following resources:
-
Locations as global, named as follows: `projects/{project_id}/locations/global`.
-
Domains, named as follows: `/projects/{project_id}/locations/global/domain/{domain_name}`.
The `{domain_name}` refers to fully qualified domain name in the customer project e.g. mydomain.myorganization.com, with the following restrictions:
* Must contain only lowercase letters, numbers, periods and hyphens. * Must start with a letter. * Must contain between 2-64 characters. * Must end with a number or a letter. * Must not start with period. * First segement length (mydomain form example above) shouldn't exceed 15 chars. * The last segment cannot be fully numeric. * Must be unique within the customer project.
@param version [::String, ::Symbol] The API version to connect to. Optional.
Defaults to `:v1`.
@return [ManagedIdentitiesService::Client] A client object for the specified version.
# File lib/google/cloud/managed_identities.rb, line 97 def self.managed_identities_service version: :v1, &block require "google/cloud/managed_identities/#{version.to_s.downcase}" package_name = Google::Cloud::ManagedIdentities .constants .select { |sym| sym.to_s.downcase == version.to_s.downcase.tr("_", "") } .first package_module = Google::Cloud::ManagedIdentities.const_get package_name package_module.const_get(:ManagedIdentitiesService).const_get(:Client).new(&block) end