Class: Google::Apis::ServiceusageV1::Usage

Inherits:
Object
  • Object
show all
Includes:
Core::Hashable, Core::JsonObjectSupport
Defined in:
lib/google/apis/serviceusage_v1/classes.rb,
lib/google/apis/serviceusage_v1/representations.rb,
lib/google/apis/serviceusage_v1/representations.rb

Overview

Configuration controlling usage of a service.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ Usage

Returns a new instance of Usage.



5024
5025
5026
 
# File 'lib/google/apis/serviceusage_v1/classes.rb', line 5024

def initialize(**args)
   update!(**args)
end

Instance Attribute Details

#producer_notification_channel ⇒ 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. Corresponds to the JSON property producerNotificationChannel

Returns:

  • (String) 


5005
5006
5007
 
# File 'lib/google/apis/serviceusage_v1/classes.rb', line 5005

def producer_notification_channel
  @producer_notification_channel
end

#requirements ⇒ 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. Corresponds to the JSON property requirements

Returns:

  • (Array<String>) 


5016
5017
5018
 
# File 'lib/google/apis/serviceusage_v1/classes.rb', line 5016

def requirements
  @requirements
end

#rules ⇒ Array<Google::Apis::ServiceusageV1::UsageRule>

A list of usage rules that apply to individual API methods. NOTE: All service configuration rules follow "last one wins" order. Corresponds to the JSON property rules

Returns:



5022
5023
5024
 
# File 'lib/google/apis/serviceusage_v1/classes.rb', line 5022

def rules
  @rules
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



5029
5030
5031
5032
5033
 
# File 'lib/google/apis/serviceusage_v1/classes.rb', line 5029

def update!(**args)
  @producer_notification_channel = args[:producer_notification_channel] if args.key?(:producer_notification_channel)
  @requirements = args[:requirements] if args.key?(:requirements)
  @rules = args[:rules] if args.key?(:rules)
end