com.google.api

Class Usage

java.lang.Object

com.google.protobuf.AbstractMessageLite

com.google.protobuf.AbstractMessage

com.google.protobuf.GeneratedMessageV3

com.google.api.Usage

All Implemented Interfaces:

UsageOrBuilder, com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, java.io.Serializable

public final class Usage
extends com.google.protobuf.GeneratedMessageV3
implements UsageOrBuilder

 Configuration controlling usage of a service.
 

Protobuf type google.api.Usage

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	Usage.Builder Configuration controlling usage of a service.

Nested classes/interfaces inherited from class com.google.protobuf.GeneratedMessageV3

com.google.protobuf.GeneratedMessageV3.BuilderParent, com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageType extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage,BuilderType extends com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageType,BuilderType>>, com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageType extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage>, com.google.protobuf.GeneratedMessageV3.ExtendableMessageOrBuilder<MessageType extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage>, com.google.protobuf.GeneratedMessageV3.FieldAccessorTable

Field Summary

Fields

Modifier and Type	Field and Description
static int	PRODUCER_NOTIFICATION_CHANNEL_FIELD_NUMBER
static int	REQUIREMENTS_FIELD_NUMBER
static int	RULES_FIELD_NUMBER

Fields inherited from class com.google.protobuf.GeneratedMessageV3

alwaysUseFieldBuilders, unknownFields

Fields inherited from class com.google.protobuf.AbstractMessage

memoizedSize

Fields inherited from class com.google.protobuf.AbstractMessageLite

memoizedHashCode

Method Summary

Modifier and Type	Method and Description
boolean	equals(java.lang.Object obj)
static Usage	getDefaultInstance()
Usage	getDefaultInstanceForType()
static com.google.protobuf.Descriptors.Descriptor	getDescriptor()
com.google.protobuf.Parser<Usage>	getParserForType()
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.
com.google.protobuf.ProtocolStringList	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.
int	getSerializedSize()
com.google.protobuf.UnknownFieldSet	getUnknownFields()
int	hashCode()
protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable	internalGetFieldAccessorTable()
boolean	isInitialized()
static Usage.Builder	newBuilder()
static Usage.Builder	newBuilder(Usage prototype)
Usage.Builder	newBuilderForType()
protected Usage.Builder	newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
static Usage	parseDelimitedFrom(java.io.InputStream input)
static Usage	parseDelimitedFrom(java.io.InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static Usage	parseFrom(byte[] data)
static Usage	parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static Usage	parseFrom(java.nio.ByteBuffer data)
static Usage	parseFrom(java.nio.ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static Usage	parseFrom(com.google.protobuf.ByteString data)
static Usage	parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static Usage	parseFrom(com.google.protobuf.CodedInputStream input)
static Usage	parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static Usage	parseFrom(java.io.InputStream input)
static Usage	parseFrom(java.io.InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static com.google.protobuf.Parser<Usage>	parser()
Usage.Builder	toBuilder()
void	writeTo(com.google.protobuf.CodedOutputStream output)

Methods inherited from class com.google.protobuf.GeneratedMessageV3

canUseUnsafe, computeStringSize, computeStringSizeNoTag, getAllFields, getDescriptorForType, getField, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, hasField, hasOneof, internalGetMapField, makeExtensionsImmutable, newBuilderForType, parseDelimitedWithIOException, parseDelimitedWithIOException, parseUnknownField, parseUnknownFieldProto3, parseWithIOException, parseWithIOException, parseWithIOException, parseWithIOException, serializeBooleanMapTo, serializeIntegerMapTo, serializeLongMapTo, serializeStringMapTo, writeReplace, writeString, writeStringNoTag

Methods inherited from class com.google.protobuf.AbstractMessage

findInitializationErrors, getInitializationErrorString, hashBoolean, hashEnum, hashEnumList, hashFields, hashLong, toString

Methods inherited from class com.google.protobuf.AbstractMessageLite

addAll, addAll, checkByteStringIsUtf8, toByteArray, toByteString, writeDelimitedTo, writeTo

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.google.protobuf.MessageOrBuilder

findInitializationErrors, getAllFields, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, hasField, hasOneof

Methods inherited from interface com.google.protobuf.MessageLite

toByteArray, toByteString, writeDelimitedTo, writeTo

Field Detail

REQUIREMENTS_FIELD_NUMBER

public static final int REQUIREMENTS_FIELD_NUMBER

See Also:

Constant Field Values

RULES_FIELD_NUMBER

public static final int RULES_FIELD_NUMBER

See Also:

Constant Field Values

PRODUCER_NOTIFICATION_CHANNEL_FIELD_NUMBER

public static final int PRODUCER_NOTIFICATION_CHANNEL_FIELD_NUMBER

See Also:

Constant Field Values

Method Detail

getUnknownFields

public final com.google.protobuf.UnknownFieldSet getUnknownFields()

Specified by:

getUnknownFields in interface com.google.protobuf.MessageOrBuilder

Overrides:

getUnknownFields in class com.google.protobuf.GeneratedMessageV3

getDescriptor

public static final com.google.protobuf.Descriptors.Descriptor getDescriptor()

internalGetFieldAccessorTable

protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()

Specified by:

internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessageV3

getRequirementsList

public com.google.protobuf.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'.
 

repeated string requirements = 1;

Specified by:

getRequirementsList in interface UsageOrBuilder

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'.
 

repeated string requirements = 1;

Specified by:

getRequirementsCount in interface UsageOrBuilder

getRequirements

public 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'.
 

repeated string requirements = 1;

Specified by:

getRequirements in interface UsageOrBuilder

getRequirementsBytes

public 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'.
 

repeated string requirements = 1;

Specified by:

getRequirementsBytes in interface UsageOrBuilder

getRulesList

public 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;

Specified by:

getRulesList in interface UsageOrBuilder

getRulesOrBuilderList

public 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;

Specified by:

getRulesOrBuilderList in interface UsageOrBuilder

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;

Specified by:

getRulesCount in interface UsageOrBuilder

getRules

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;

Specified by:

getRules in interface UsageOrBuilder

getRulesOrBuilder

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;

Specified by:

getRulesOrBuilder in interface UsageOrBuilder

getProducerNotificationChannel

public 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;

Specified by:

getProducerNotificationChannel in interface UsageOrBuilder

getProducerNotificationChannelBytes

public 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;

Specified by:

getProducerNotificationChannelBytes in interface UsageOrBuilder

isInitialized

public final boolean isInitialized()

Specified by:

isInitialized in interface com.google.protobuf.MessageLiteOrBuilder

Overrides:

isInitialized in class com.google.protobuf.GeneratedMessageV3

writeTo

public void writeTo(com.google.protobuf.CodedOutputStream output)
             throws java.io.IOException

Specified by:

writeTo in interface com.google.protobuf.MessageLite

Overrides:

writeTo in class com.google.protobuf.GeneratedMessageV3

Throws:

java.io.IOException

getSerializedSize

public int getSerializedSize()

Specified by:

getSerializedSize in interface com.google.protobuf.MessageLite

Overrides:

getSerializedSize in class com.google.protobuf.GeneratedMessageV3

equals

public boolean equals(java.lang.Object obj)

Specified by:

equals in interface com.google.protobuf.Message

Overrides:

equals in class com.google.protobuf.AbstractMessage

hashCode

public int hashCode()

Specified by:

hashCode in interface com.google.protobuf.Message

Overrides:

hashCode in class com.google.protobuf.AbstractMessage

parseFrom

public static Usage parseFrom(java.nio.ByteBuffer data)
                       throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static Usage parseFrom(java.nio.ByteBuffer data,
                              com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                       throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static Usage parseFrom(com.google.protobuf.ByteString data)
                       throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static Usage parseFrom(com.google.protobuf.ByteString data,
                              com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                       throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static Usage parseFrom(byte[] data)
                       throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static Usage parseFrom(byte[] data,
                              com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                       throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static Usage parseFrom(java.io.InputStream input)
                       throws java.io.IOException

Throws:

java.io.IOException

parseFrom

public static Usage parseFrom(java.io.InputStream input,
                              com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                       throws java.io.IOException

Throws:

java.io.IOException

parseDelimitedFrom

public static Usage parseDelimitedFrom(java.io.InputStream input)
                                throws java.io.IOException

Throws:

java.io.IOException

parseDelimitedFrom

public static Usage parseDelimitedFrom(java.io.InputStream input,
                                       com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                throws java.io.IOException

Throws:

java.io.IOException

parseFrom

public static Usage parseFrom(com.google.protobuf.CodedInputStream input)
                       throws java.io.IOException

Throws:

java.io.IOException

parseFrom

public static Usage parseFrom(com.google.protobuf.CodedInputStream input,
                              com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                       throws java.io.IOException

Throws:

java.io.IOException

newBuilderForType

public Usage.Builder newBuilderForType()

Specified by:

newBuilderForType in interface com.google.protobuf.Message

Specified by:

newBuilderForType in interface com.google.protobuf.MessageLite

newBuilder

public static Usage.Builder newBuilder()

newBuilder

public static Usage.Builder newBuilder(Usage prototype)

toBuilder

public Usage.Builder toBuilder()

Specified by:

toBuilder in interface com.google.protobuf.Message

Specified by:

toBuilder in interface com.google.protobuf.MessageLite

newBuilderForType

protected Usage.Builder newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)

Specified by:

newBuilderForType in class com.google.protobuf.GeneratedMessageV3

getDefaultInstance

public static Usage getDefaultInstance()

parser

public static com.google.protobuf.Parser<Usage> parser()

getParserForType

public com.google.protobuf.Parser<Usage> getParserForType()

Specified by:

getParserForType in interface com.google.protobuf.Message

Specified by:

getParserForType in interface com.google.protobuf.MessageLite

Overrides:

getParserForType in class com.google.protobuf.GeneratedMessageV3

getDefaultInstanceForType

public Usage getDefaultInstanceForType()

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder