Reference documentation and code samples for the Service Usage API module Google::Cloud::ServiceUsage.
Methods
.configure
defself.configure()->::Google::Cloud::Config
Configure the google-cloud-service_usage 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.service_usage)
Returns
(::Google::Cloud::Config) — The default configuration used by this library
By default, this returns an instance of
Google::Cloud::ServiceUsage::V1::ServiceUsage::Client
for a gRPC client for version V1 of the API.
However, you can specify a different API version by passing it in the
version parameter. If the ServiceUsage service is
supported by that API version, and the corresponding gem is available, the
appropriate versioned client will be returned.
Raises an exception if the currently installed versioned client gem for the
given API version does not support the ServiceUsage service.
You can determine whether the method will succeed by calling
ServiceUsage.service_usage_available?.
About ServiceUsage
Enables services that service consumers want to use on Google Cloud Platform,
lists the available or enabled services, or disables services that service
consumers no longer use.
Determines whether the ServiceUsage service is supported by the current client.
If true, you can retrieve a client object by calling ServiceUsage.service_usage.
If false, that method will raise an exception. This could happen if the given
API version does not exist or does not support the ServiceUsage service,
or if the versioned client gem needs an update to support the ServiceUsage service.
Parameter
version (::String, ::Symbol) (defaults to: :v1) — The API version to connect to. Optional.
Defaults to :v1.
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Hard to understand","hardToUnderstand","thumb-down"],["Incorrect information or sample code","incorrectInformationOrSampleCode","thumb-down"],["Missing the information/samples I need","missingTheInformationSamplesINeed","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2025-09-03 UTC."],[],[],null,["# Service Usage API - Module Google::Cloud::ServiceUsage (v1.4.1)\n\nVersion latestkeyboard_arrow_down\n\n- [1.4.1 (latest)](/ruby/docs/reference/google-cloud-service_usage/latest/Google-Cloud-ServiceUsage)\n- [1.4.0](/ruby/docs/reference/google-cloud-service_usage/1.4.0/Google-Cloud-ServiceUsage)\n- [1.3.1](/ruby/docs/reference/google-cloud-service_usage/1.3.1/Google-Cloud-ServiceUsage)\n- [1.2.0](/ruby/docs/reference/google-cloud-service_usage/1.2.0/Google-Cloud-ServiceUsage)\n- [1.1.0](/ruby/docs/reference/google-cloud-service_usage/1.1.0/Google-Cloud-ServiceUsage)\n- [1.0.1](/ruby/docs/reference/google-cloud-service_usage/1.0.1/Google-Cloud-ServiceUsage) \nReference documentation and code samples for the Service Usage API module Google::Cloud::ServiceUsage.\n\nMethods\n-------\n\n### .configure\n\n def self.configure() -\u003e ::Google::Cloud::Config\n\nConfigure the google-cloud-service_usage library.\n\nThe following configuration parameters are supported:\n\n- `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.\n- `lib_name` (*type:* `String`) - The library name as recorded in instrumentation and logging.\n- `lib_version` (*type:* `String`) - The library version as recorded in instrumentation and logging.\n- `interceptors` (*type:* `Array\u003cGRPC::ClientInterceptor\u003e`) - An array of interceptors that are run before calls are executed.\n- `timeout` (*type:* `Numeric`) - Default timeout in seconds.\n- `metadata` (*type:* `Hash{Symbol=\u003eString}`) - Additional headers to be sent with the call.\n- `retry_policy` (*type:* `Hash`) - The retry policy. The value is a hash with the following keys:\n - `:initial_delay` (*type:* `Numeric`) - The initial delay in seconds.\n - `:max_delay` (*type:* `Numeric`) - The max delay in seconds.\n - `:multiplier` (*type:* `Numeric`) - The incremental backoff multiplier.\n- `:retry_codes` (*type:* `Array\u003cString\u003e`) - The error codes that should trigger a retry. \n**Yields**\n\n- (::Google::Cloud.configure.service_usage) \n**Returns**\n\n- (::Google::Cloud::Config) --- The default configuration used by this library\n\n### .service_usage\n\n def self.service_usage(version: :v1, &block) -\u003e ::Object\n\nCreate a new client object for ServiceUsage.\n\n\nBy default, this returns an instance of\n[Google::Cloud::ServiceUsage::V1::ServiceUsage::Client](https://cloud.google.com/ruby/docs/reference/google-cloud-service_usage-v1/latest/Google-Cloud-ServiceUsage-V1-ServiceUsage-Client)\nfor a gRPC client for version V1 of the API.\nHowever, you can specify a different API version by passing it in the\n`version` parameter. If the ServiceUsage service is\nsupported by that API version, and the corresponding gem is available, the\nappropriate versioned client will be returned.\n\nRaises an exception if the currently installed versioned client gem for the\ngiven API version does not support the ServiceUsage service.\nYou can determine whether the method will succeed by calling\n[ServiceUsage.service_usage_available?](/ruby/docs/reference/google-cloud-service_usage/latest/Google-Cloud-ServiceUsage#Google__Cloud__ServiceUsage_service_usage_available__class_ \"Google::Cloud::ServiceUsage.service_usage_available? (method)\").\n\n#### About ServiceUsage\n\nEnables services that service consumers want to use on Google Cloud Platform,\nlists the available or enabled services, or disables services that service\nconsumers no longer use.\n\n\u003cbr /\u003e\n\nSee [Service Usage API](https://cloud.google.com/service-usage/docs/overview) \n**Parameter**\n\n- **version** (::String, ::Symbol) *(defaults to: :v1)* --- The API version to connect to. Optional. Defaults to `:v1`. \n**Returns**\n\n- (::Object) --- A client object for the specified version.\n\n### .service_usage_available?\n\n def self.service_usage_available?(version: :v1) -\u003e boolean\n\nDetermines whether the ServiceUsage service is supported by the current client.\nIf true, you can retrieve a client object by calling [ServiceUsage.service_usage](/ruby/docs/reference/google-cloud-service_usage/latest/Google-Cloud-ServiceUsage#Google__Cloud__ServiceUsage_service_usage_class_ \"Google::Cloud::ServiceUsage.service_usage (method)\").\nIf false, that method will raise an exception. This could happen if the given\nAPI version does not exist or does not support the ServiceUsage service,\nor if the versioned client gem needs an update to support the ServiceUsage service. \n**Parameter**\n\n- **version** (::String, ::Symbol) *(defaults to: :v1)* --- The API version to connect to. Optional. Defaults to `:v1`. \n**Returns**\n\n- (boolean) --- Whether the service is available.\n\nConstants\n---------\n\n### VERSION\n\n**value:**\"1.4.1\""]]