public final class Usage extends GeneratedMessage implements UsageOrBuilder
Configuration controlling usage of a service.
Protobuf type google.api.Usage
Inherited Members
com.google.protobuf.GeneratedMessage.<ContainingT,T>newFileScopedGeneratedExtension(java.lang.Class<?>,com.google.protobuf.Message)
com.google.protobuf.GeneratedMessage.<ContainingT,T>newMessageScopedGeneratedExtension(com.google.protobuf.Message,int,java.lang.Class<?>,com.google.protobuf.Message)
com.google.protobuf.GeneratedMessage.<ListT>makeMutableCopy(ListT)
com.google.protobuf.GeneratedMessage.<ListT>makeMutableCopy(ListT,int)
com.google.protobuf.GeneratedMessage.<T>emptyList(java.lang.Class<T>)
com.google.protobuf.GeneratedMessage.<V>serializeBooleanMapTo(com.google.protobuf.CodedOutputStream,com.google.protobuf.MapField<java.lang.Boolean,V>,com.google.protobuf.MapEntry<java.lang.Boolean,V>,int)
com.google.protobuf.GeneratedMessage.<V>serializeIntegerMapTo(com.google.protobuf.CodedOutputStream,com.google.protobuf.MapField<java.lang.Integer,V>,com.google.protobuf.MapEntry<java.lang.Integer,V>,int)
com.google.protobuf.GeneratedMessage.<V>serializeLongMapTo(com.google.protobuf.CodedOutputStream,com.google.protobuf.MapField<java.lang.Long,V>,com.google.protobuf.MapEntry<java.lang.Long,V>,int)
com.google.protobuf.GeneratedMessage.<V>serializeStringMapTo(com.google.protobuf.CodedOutputStream,com.google.protobuf.MapField<java.lang.String,V>,com.google.protobuf.MapEntry<java.lang.String,V>,int)
com.google.protobuf.GeneratedMessage.canUseUnsafe()
com.google.protobuf.GeneratedMessage.emptyBooleanList()
com.google.protobuf.GeneratedMessage.emptyDoubleList()
com.google.protobuf.GeneratedMessage.emptyFloatList()
com.google.protobuf.GeneratedMessage.emptyIntList()
com.google.protobuf.GeneratedMessage.emptyLongList()
com.google.protobuf.GeneratedMessage.internalGetMapFieldReflection(int)
com.google.protobuf.GeneratedMessage.isStringEmpty(java.lang.Object)
com.google.protobuf.GeneratedMessage.mergeFromAndMakeImmutableInternal(com.google.protobuf.CodedInputStream,com.google.protobuf.ExtensionRegistryLite)
com.google.protobuf.GeneratedMessage.newInstance(com.google.protobuf.GeneratedMessage.UnusedPrivateParameter)
com.google.protobuf.GeneratedMessage.parseUnknownFieldProto3(com.google.protobuf.CodedInputStream,com.google.protobuf.UnknownFieldSet.Builder,com.google.protobuf.ExtensionRegistryLite,int)
Static Fields
PRODUCER_NOTIFICATION_CHANNEL_FIELD_NUMBER
public static final int PRODUCER_NOTIFICATION_CHANNEL_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
REQUIREMENTS_FIELD_NUMBER
public static final int REQUIREMENTS_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
RULES_FIELD_NUMBER
public static final int RULES_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
Static Methods
getDefaultInstance()
public static Usage getDefaultInstance()
| Returns |
| Type |
Description |
Usage |
|
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()
newBuilder()
public static Usage.Builder newBuilder()
newBuilder(Usage prototype)
public static Usage.Builder newBuilder(Usage prototype)
| Parameter |
| Name |
Description |
prototype |
Usage
|
public static Usage parseDelimitedFrom(InputStream input)
| Returns |
| Type |
Description |
Usage |
|
public static Usage parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
| Returns |
| Type |
Description |
Usage |
|
parseFrom(byte[] data)
public static Usage parseFrom(byte[] data)
| Parameter |
| Name |
Description |
data |
byte[]
|
| Returns |
| Type |
Description |
Usage |
|
parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
public static Usage parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
| Returns |
| Type |
Description |
Usage |
|
parseFrom(ByteString data)
public static Usage parseFrom(ByteString data)
| Returns |
| Type |
Description |
Usage |
|
parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static Usage parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
| Returns |
| Type |
Description |
Usage |
|
public static Usage parseFrom(CodedInputStream input)
| Returns |
| Type |
Description |
Usage |
|
public static Usage parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
| Returns |
| Type |
Description |
Usage |
|
public static Usage parseFrom(InputStream input)
| Returns |
| Type |
Description |
Usage |
|
public static Usage parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
| Returns |
| Type |
Description |
Usage |
|
parseFrom(ByteBuffer data)
public static Usage parseFrom(ByteBuffer data)
| Returns |
| Type |
Description |
Usage |
|
parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
public static Usage parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
| Returns |
| Type |
Description |
Usage |
|
parser()
public static Parser<Usage> parser()
Methods
equals(Object obj)
public boolean equals(Object obj)
| Parameter |
| Name |
Description |
obj |
Object
|
Overrides
getDefaultInstanceForType()
public Usage getDefaultInstanceForType()
| Returns |
| Type |
Description |
Usage |
|
getParserForType()
public Parser<Usage> getParserForType()
Overrides
getProducerNotificationChannel()
public 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 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 |
| Type |
Description |
String |
The producerNotificationChannel.
|
getProducerNotificationChannelBytes()
public 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 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 |
| Type |
Description |
ByteString |
The bytes for producerNotificationChannel.
|
getRequirements(int index)
public 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;
| 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)
public 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;
| 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()
public 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 |
| Type |
Description |
int |
The count of requirements.
|
getRequirementsList()
public ProtocolStringList 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;
getRules(int index)
public 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;
| Parameter |
| Name |
Description |
index |
int
|
getRulesCount()
public 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()
public 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;
getRulesOrBuilder(int index)
public 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;
| Parameter |
| Name |
Description |
index |
int
|
getRulesOrBuilderList()
public 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;
| Returns |
| Type |
Description |
List<? extends com.google.api.UsageRuleOrBuilder> |
|
getSerializedSize()
public int getSerializedSize()
| Returns |
| Type |
Description |
int |
|
Overrides
hashCode()
| Returns |
| Type |
Description |
int |
|
Overrides
internalGetFieldAccessorTable()
protected GeneratedMessage.FieldAccessorTable internalGetFieldAccessorTable()
Overrides
isInitialized()
public final boolean isInitialized()
Overrides
newBuilderForType()
public Usage.Builder newBuilderForType()
newBuilderForType(AbstractMessage.BuilderParent parent)
protected Usage.Builder newBuilderForType(AbstractMessage.BuilderParent parent)
Overrides
toBuilder()
public Usage.Builder toBuilder()
writeTo(CodedOutputStream output)
public void writeTo(CodedOutputStream output)
Overrides
