publicfinalclassUsageextendsGeneratedMessageV3implementsUsageOrBuilder
Configuration controlling usage of a service.
Protobuf typegoogle.api.Usage
Static Fields
PRODUCER_NOTIFICATION_CHANNEL_FIELD_NUMBER
publicstaticfinalintPRODUCER_NOTIFICATION_CHANNEL_FIELD_NUMBER
REQUIREMENTS_FIELD_NUMBER
publicstaticfinalintREQUIREMENTS_FIELD_NUMBER
RULES_FIELD_NUMBER
publicstaticfinalintRULES_FIELD_NUMBER
Static Methods
getDefaultInstance()
publicstaticUsagegetDefaultInstance()
getDescriptor()
publicstaticfinalDescriptors.DescriptorgetDescriptor()
newBuilder()
publicstaticUsage.BuildernewBuilder()
newBuilder(Usage prototype)
publicstaticUsage.BuildernewBuilder(Usageprototype)
| Name | Description |
| prototype | Usage
|
ReturnsparseDelimitedFrom(InputStream input)
publicstaticUsageparseDelimitedFrom(InputStreaminput)
parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
publicstaticUsageparseDelimitedFrom(InputStreaminput,ExtensionRegistryLiteextensionRegistry)
parseFrom(byte[] data)
publicstaticUsageparseFrom(byte[]data)
| Name | Description |
| data | byte[]
|
ReturnsExceptionsparseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
publicstaticUsageparseFrom(byte[]data,ExtensionRegistryLiteextensionRegistry)
parseFrom(ByteString data)
publicstaticUsageparseFrom(ByteStringdata)
parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
publicstaticUsageparseFrom(ByteStringdata,ExtensionRegistryLiteextensionRegistry)
parseFrom(CodedInputStream input)
publicstaticUsageparseFrom(CodedInputStreaminput)
parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
publicstaticUsageparseFrom(CodedInputStreaminput,ExtensionRegistryLiteextensionRegistry)
parseFrom(InputStream input)
publicstaticUsageparseFrom(InputStreaminput)
parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
publicstaticUsageparseFrom(InputStreaminput,ExtensionRegistryLiteextensionRegistry)
parseFrom(ByteBuffer data)
publicstaticUsageparseFrom(ByteBufferdata)
parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
publicstaticUsageparseFrom(ByteBufferdata,ExtensionRegistryLiteextensionRegistry)
parser()
publicstaticParser<Usage>parser()
Methods
equals(Object obj)
publicbooleanequals(Objectobj)
getDefaultInstanceForType()
publicUsagegetDefaultInstanceForType()
getParserForType()
publicParser<Usage>getParserForType()
getProducerNotificationChannel()
publicStringgetProducerNotificationChannel()
The full resource name of a channel used for sending notifications to the service producer. Google Service Management currently only supportsGoogle 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 inhttps://cloud.google.com/pubsub/docs/overview.
string producer_notification_channel = 7;
| Type | Description |
| String | The producerNotificationChannel. |
getProducerNotificationChannelBytes()
publicByteStringgetProducerNotificationChannelBytes()
The full resource name of a channel used for sending notifications to the service producer. Google Service Management currently only supportsGoogle 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 inhttps://cloud.google.com/pubsub/docs/overview.
string producer_notification_channel = 7;
| Type | Description |
| ByteString | The bytes for producerNotificationChannel. |
getRequirements(int index)
publicStringgetRequirements(intindex)
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;
| Name | Description |
| index | int
The index of the element to return. |
Returns| Type | Description |
| String | The requirements at the given index. |
getRequirementsBytes(int index)
publicByteStringgetRequirementsBytes(intindex)
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;
| Name | Description |
| index | int
The index of the value to return. |
Returns| Type | Description |
| ByteString | The bytes of the requirements at the given index. |
getRequirementsCount()
publicintgetRequirementsCount()
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;
| Type | Description |
| int | The count of requirements. |
getRequirementsList()
publicProtocolStringListgetRequirementsList()
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;
getRules(int index)
publicUsageRulegetRules(intindex)
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()
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;
getRulesList()
publicList<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;
getRulesOrBuilder(int index)
publicUsageRuleOrBuildergetRulesOrBuilder(intindex)
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()
publicList<?extendsUsageRuleOrBuilder>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;
| Type | Description |
| List<? extends com.google.api.UsageRuleOrBuilder> | |
getSerializedSize()
publicintgetSerializedSize()
getUnknownFields()
publicfinalUnknownFieldSetgetUnknownFields()
hashCode()
ReturnsOverridesinternalGetFieldAccessorTable()
protectedGeneratedMessageV3.FieldAccessorTableinternalGetFieldAccessorTable()
isInitialized()
publicfinalbooleanisInitialized()
newBuilderForType()
publicUsage.BuildernewBuilderForType()
newBuilderForType(GeneratedMessageV3.BuilderParent parent)
protectedUsage.BuildernewBuilderForType(GeneratedMessageV3.BuilderParentparent)
newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
protectedObjectnewInstance(GeneratedMessageV3.UnusedPrivateParameterunused)
toBuilder()
publicUsage.BuildertoBuilder()
writeTo(CodedOutputStream output)
publicvoidwriteTo(CodedOutputStreamoutput)
