Service Usage V1 API - Class Google::Api::Usage (v1.5.1)

Reference documentation and code samples for the Service Usage V1 API class Google::Api::Usage.

Configuration controlling usage of a service.

Inherits

  • Object

Extended By

  • Google::Protobuf::MessageExts::ClassMethods

Includes

  • Google::Protobuf::MessageExts

Methods

#producer_notification_channel

defproducer_notification_channel()->::String
Returns

#producer_notification_channel=

defproducer_notification_channel=(value)->::String
Parameter
  • value (::String) — The full resource name of a channel used for sending notifications to theservice producer.

    Google Service Management currently only supportsGoogle Cloud Pub/Sub as a notificationchannel. To use Google Cloud Pub/Sub as the channel, this must be the nameof a Cloud Pub/Sub topic that uses the Cloud Pub/Sub topic name formatdocumented in https://cloud.google.com/pubsub/docs/overview.

Returns
  • (::String) — The full resource name of a channel used for sending notifications to theservice producer.

    Google Service Management currently only supportsGoogle Cloud Pub/Sub as a notificationchannel. To use Google Cloud Pub/Sub as the channel, this must be the nameof a Cloud Pub/Sub topic that uses the Cloud Pub/Sub topic name formatdocumented in https://cloud.google.com/pubsub/docs/overview.

#requirements

defrequirements()->::Array<::String>
Returns
  • (::Array<::String>) — Requirements that must be satisfied before a consumer project can use theservice. Each requirement is of the form

#requirements=

defrequirements=(value)->::Array<::String>
Parameter
  • value (::Array<::String>) — Requirements that must be satisfied before a consumer project can use theservice. Each requirement is of the form
Returns
  • (::Array<::String>) — Requirements that must be satisfied before a consumer project can use theservice. Each requirement is of the form

#rules

defrules()->::Array<::Google::Api::UsageRule>
Returns
  • (::Array<::Google::Api::UsageRule>) — A list of usage rules that apply to individual API methods.

    NOTE: All service configuration rules follow "last one wins" order.

#rules=

defrules=(value)->::Array<::Google::Api::UsageRule>
Parameter
  • value (::Array<::Google::Api::UsageRule>) — A list of usage rules that apply to individual API methods.

    NOTE: All service configuration rules follow "last one wins" order.

Returns
  • (::Array<::Google::Api::UsageRule>) — A list of usage rules that apply to individual API methods.

    NOTE: All service configuration rules follow "last one wins" order.

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.