publicfinalclassUsageextendsGeneratedMessageV3implementsUsageOrBuilder
Configuration controlling usage of a service.
Protobuf typegoogle.api.Usage
Inherited Members
com.google.protobuf.GeneratedMessageV3.<ListT>makeMutableCopy(ListT)
com.google.protobuf.GeneratedMessageV3.<ListT>makeMutableCopy(ListT,int)
com.google.protobuf.GeneratedMessageV3.<T>emptyList(java.lang.Class<T>)
com.google.protobuf.GeneratedMessageV3.internalGetMapFieldReflection(int)
Static Fields
PRODUCER_NOTIFICATION_CHANNEL_FIELD_NUMBER
publicstaticfinalintPRODUCER_NOTIFICATION_CHANNEL_FIELD_NUMBER
| Field Value |
|---|
| Type | Description |
int | |
REQUIREMENTS_FIELD_NUMBER
publicstaticfinalintREQUIREMENTS_FIELD_NUMBER
| Field Value |
|---|
| Type | Description |
int | |
RULES_FIELD_NUMBER
publicstaticfinalintRULES_FIELD_NUMBER
| Field Value |
|---|
| Type | Description |
int | |
Static Methods
getDefaultInstance()
publicstaticUsagegetDefaultInstance()
| Returns |
|---|
| Type | Description |
Usage | |
getDescriptor()
publicstaticfinalDescriptors.DescriptorgetDescriptor()
newBuilder()
publicstaticUsage.BuildernewBuilder()
newBuilder(Usage prototype)
publicstaticUsage.BuildernewBuilder(Usageprototype)
| Parameter |
|---|
| Name | Description |
prototype | Usage
|
parseDelimitedFrom(InputStream input)
publicstaticUsageparseDelimitedFrom(InputStreaminput)
| Returns |
|---|
| Type | Description |
Usage | |
parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
publicstaticUsageparseDelimitedFrom(InputStreaminput,ExtensionRegistryLiteextensionRegistry)
| Returns |
|---|
| Type | Description |
Usage | |
parseFrom(byte[] data)
publicstaticUsageparseFrom(byte[]data)
| Parameter |
|---|
| Name | Description |
data | byte[]
|
| Returns |
|---|
| Type | Description |
Usage | |
parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
publicstaticUsageparseFrom(byte[]data,ExtensionRegistryLiteextensionRegistry)
| Returns |
|---|
| Type | Description |
Usage | |
parseFrom(ByteString data)
publicstaticUsageparseFrom(ByteStringdata)
| Returns |
|---|
| Type | Description |
Usage | |
parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
publicstaticUsageparseFrom(ByteStringdata,ExtensionRegistryLiteextensionRegistry)
| Returns |
|---|
| Type | Description |
Usage | |
parseFrom(CodedInputStream input)
publicstaticUsageparseFrom(CodedInputStreaminput)
| Returns |
|---|
| Type | Description |
Usage | |
parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
publicstaticUsageparseFrom(CodedInputStreaminput,ExtensionRegistryLiteextensionRegistry)
| Returns |
|---|
| Type | Description |
Usage | |
parseFrom(InputStream input)
publicstaticUsageparseFrom(InputStreaminput)
| Returns |
|---|
| Type | Description |
Usage | |
parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
publicstaticUsageparseFrom(InputStreaminput,ExtensionRegistryLiteextensionRegistry)
| Returns |
|---|
| Type | Description |
Usage | |
parseFrom(ByteBuffer data)
publicstaticUsageparseFrom(ByteBufferdata)
| Returns |
|---|
| Type | Description |
Usage | |
parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
publicstaticUsageparseFrom(ByteBufferdata,ExtensionRegistryLiteextensionRegistry)
| Returns |
|---|
| Type | Description |
Usage | |
parser()
publicstaticParser<Usage>parser()
Methods
equals(Object obj)
publicbooleanequals(Objectobj)
| Parameter |
|---|
| Name | Description |
obj | Object
|
OverridesgetDefaultInstanceForType()
publicUsagegetDefaultInstanceForType()
| Returns |
|---|
| Type | Description |
Usage | |
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;
| Returns |
|---|
| 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;
| Returns |
|---|
| 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;
| Parameter |
|---|
| 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;
| Parameter |
|---|
| 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;
| Returns |
|---|
| 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;
| Parameter |
|---|
| Name | Description |
index | 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;
| Returns |
|---|
| Type | Description |
int | |
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;
| Parameter |
|---|
| Name | Description |
index | int
|
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;
| Returns |
|---|
| Type | Description |
List<? extends com.google.api.UsageRuleOrBuilder> | |
getSerializedSize()
publicintgetSerializedSize()
| Returns |
|---|
| Type | Description |
int | |
OverrideshashCode()
| Returns |
|---|
| Type | Description |
int | |
OverridesinternalGetFieldAccessorTable()
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)
