Class: Google::Api::Usage

Inherits:
Object
  • Object
show all
Extended by:
Protobuf::MessageExts::ClassMethods
Includes:
Protobuf::MessageExts
Defined in:
proto_docs/google/api/usage.rb

Overview

Configuration controlling usage of a service.

Instance Attribute Summary collapse

Instance Attribute Details

#producer_notification_channel ⇒ ::String

Returns The full resource name of a channel used for sending notifications to the service producer.

Google Service Management currently only supports Google Cloud Pub/Sub as a notification channel. To use Google Cloud Pub/Sub as the channel, this must be the name of a Cloud Pub/Sub topic that uses the Cloud Pub/Sub topic name format documented in https://cloud.google.com/pubsub/docs/overview.

Returns:

  • (::String) —

    The full resource name of a channel used for sending notifications to the service producer.

    Google Service Management currently only supports Google Cloud Pub/Sub as a notification channel. To use Google Cloud Pub/Sub as the channel, this must be the name of a Cloud Pub/Sub topic that uses the Cloud Pub/Sub topic name format documented in https://cloud.google.com/pubsub/docs/overview.



49
50
51
52
 
# File 'proto_docs/google/api/usage.rb', line 49

class Usage
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end

#requirements ⇒ ::Array<::String>

Returns Requirements that must be satisfied before a consumer project can use the service. Each requirement is of the form /; for example 'serviceusage.googleapis.com/billing-enabled'.

For Google APIs, a Terms of Service requirement must be included here. Google Cloud APIs must include "serviceusage.googleapis.com/tos/cloud". Other Google APIs should include "serviceusage.googleapis.com/tos/universal". Additional ToS can be included based on the business needs.

Returns:

  • (::Array<::String>) —

    Requirements that must be satisfied before a consumer project can use the service. Each requirement is of the form /; for example 'serviceusage.googleapis.com/billing-enabled'.

    For Google APIs, a Terms of Service requirement must be included here. Google Cloud APIs must include "serviceusage.googleapis.com/tos/cloud". Other Google APIs should include "serviceusage.googleapis.com/tos/universal". Additional ToS can be included based on the business needs.



49
50
51
52
 
# File 'proto_docs/google/api/usage.rb', line 49

class Usage
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end

#rules ⇒ ::Array<::Google::Api::UsageRule>

Returns 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.



49
50
51
52
 
# File 'proto_docs/google/api/usage.rb', line 49

class Usage
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end