API Keys API - Module Google::Cloud::ApiKeys (v1.3.2)

Reference documentation and code samples for the API Keys API module Google::Cloud::ApiKeys.

Methods

.api_keys

defself.api_keys(version::v2,transport::grpc,&block)->::Object

Create a new client object for ApiKeys.

By default, this returns an instance ofGoogle::Cloud::ApiKeys::V2::ApiKeys::Clientfor a gRPC client for version V2 of the API.However, you can specify a different API version by passing it in theversion parameter. If the ApiKeys service issupported by that API version, and the corresponding gem is available, theappropriate versioned client will be returned.You can also specify a different transport by passing:rest or:grpc inthetransport parameter.

Raises an exception if the currently installed versioned client gem for thegiven API version does not support the given transport of the ApiKeys service.You can determine whether the method will succeed by callingApiKeys.api_keys_available?.

About ApiKeys

Manages the API keys associated with projects.

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

.api_keys_available?

defself.api_keys_available?(version::v2,transport::grpc)->boolean

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

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

.configure

defself.configure()->::Google::Cloud::Config

Configure the google-cloud-api_keys 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 aHash, 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.api_keys)
Returns
  • (::Google::Cloud::Config) — The default configuration used by this library

Constants

VERSION

value:"1.3.2"

Except as otherwise noted, the content of this page is licensed under theCreative Commons Attribution 4.0 License, and code samples are licensed under theApache 2.0 License. For details, see theGoogle Developers Site Policies. Java is a registered trademark of Oracle and/or its affiliates.

Last updated 2025-10-30 UTC.