Package com.google.api
Interface UsageOrBuilder
-
- All Superinterfaces:
com.google.protobuf.MessageLiteOrBuilder
,com.google.protobuf.MessageOrBuilder
- All Known Implementing Classes:
Usage
,Usage.Builder
public interface UsageOrBuilder extends com.google.protobuf.MessageOrBuilder
-
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description java.lang.String
getProducerNotificationChannel()
The full resource name of a channel used for sending notifications to the service producer.com.google.protobuf.ByteString
getProducerNotificationChannelBytes()
The full resource name of a channel used for sending notifications to the service producer.java.lang.String
getRequirements(int index)
Requirements that must be satisfied before a consumer project can use the service.com.google.protobuf.ByteString
getRequirementsBytes(int index)
Requirements that must be satisfied before a consumer project can use the service.int
getRequirementsCount()
Requirements that must be satisfied before a consumer project can use the service.java.util.List<java.lang.String>
getRequirementsList()
Requirements that must be satisfied before a consumer project can use the service.UsageRule
getRules(int index)
A list of usage rules that apply to individual API methods.int
getRulesCount()
A list of usage rules that apply to individual API methods.java.util.List<UsageRule>
getRulesList()
A list of usage rules that apply to individual API methods.UsageRuleOrBuilder
getRulesOrBuilder(int index)
A list of usage rules that apply to individual API methods.java.util.List<? extends UsageRuleOrBuilder>
getRulesOrBuilderList()
A list of usage rules that apply to individual API methods.-
Methods inherited from interface com.google.protobuf.MessageOrBuilder
findInitializationErrors, getAllFields, getDefaultInstanceForType, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof
-
-
-
-
Method Detail
-
getRequirementsList
java.util.List<java.lang.String> getRequirementsList()
Requirements that must be satisfied before a consumer project can use the service. Each requirement is of the form <service.name>/<requirement-id>; 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.
repeated string requirements = 1;
- Returns:
- A list containing the requirements.
-
getRequirementsCount
int getRequirementsCount()
Requirements that must be satisfied before a consumer project can use the service. Each requirement is of the form <service.name>/<requirement-id>; 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.
repeated string requirements = 1;
- Returns:
- The count of requirements.
-
getRequirements
java.lang.String getRequirements(int index)
Requirements that must be satisfied before a consumer project can use the service. Each requirement is of the form <service.name>/<requirement-id>; 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.
repeated string requirements = 1;
- Parameters:
index
- The index of the element to return.- Returns:
- The requirements at the given index.
-
getRequirementsBytes
com.google.protobuf.ByteString getRequirementsBytes(int index)
Requirements that must be satisfied before a consumer project can use the service. Each requirement is of the form <service.name>/<requirement-id>; 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.
repeated string requirements = 1;
- Parameters:
index
- The index of the value to return.- Returns:
- The bytes of the requirements at the given index.
-
getRulesList
java.util.List<UsageRule> getRulesList()
A list of usage rules that apply to individual API methods. **NOTE:** All service configuration rules follow "last one wins" order.
repeated .google.api.UsageRule rules = 6;
-
getRules
UsageRule getRules(int index)
A list of usage rules that apply to individual API methods. **NOTE:** All service configuration rules follow "last one wins" order.
repeated .google.api.UsageRule rules = 6;
-
getRulesCount
int getRulesCount()
A list of usage rules that apply to individual API methods. **NOTE:** All service configuration rules follow "last one wins" order.
repeated .google.api.UsageRule rules = 6;
-
getRulesOrBuilderList
java.util.List<? extends UsageRuleOrBuilder> getRulesOrBuilderList()
A list of usage rules that apply to individual API methods. **NOTE:** All service configuration rules follow "last one wins" order.
repeated .google.api.UsageRule rules = 6;
-
getRulesOrBuilder
UsageRuleOrBuilder getRulesOrBuilder(int index)
A list of usage rules that apply to individual API methods. **NOTE:** All service configuration rules follow "last one wins" order.
repeated .google.api.UsageRule rules = 6;
-
getProducerNotificationChannel
java.lang.String getProducerNotificationChannel()
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](https://cloud.google.com/pubsub) 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.
string producer_notification_channel = 7;
- Returns:
- The producerNotificationChannel.
-
getProducerNotificationChannelBytes
com.google.protobuf.ByteString getProducerNotificationChannelBytes()
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](https://cloud.google.com/pubsub) 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.
string producer_notification_channel = 7;
- Returns:
- The bytes for producerNotificationChannel.
-
-