com.google.api

Class Usage.Builder

java.lang.Object

com.google.protobuf.AbstractMessageLite.Builder

com.google.protobuf.AbstractMessage.Builder<BuilderType>

com.google.protobuf.GeneratedMessageV3.Builder<Usage.Builder>

com.google.api.Usage.Builder

All Implemented Interfaces:

UsageOrBuilder, com.google.protobuf.Message.Builder, com.google.protobuf.MessageLite.Builder, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, java.lang.Cloneable

Enclosing class:

Usage

public static final class Usage.Builder
extends com.google.protobuf.GeneratedMessageV3.Builder<Usage.Builder>
implements UsageOrBuilder

 Configuration controlling usage of a service.
 

Protobuf type google.api.Usage

Method Summary

Modifier and Type	Method and Description
Usage.Builder	addAllRequirements(java.lang.Iterable<java.lang.String> values) Requirements that must be satisfied before a consumer project can use the service.
Usage.Builder	addAllRules(java.lang.Iterable<? extends UsageRule> values) A list of usage rules that apply to individual API methods.
Usage.Builder	addRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field, java.lang.Object value)
Usage.Builder	addRequirements(java.lang.String value) Requirements that must be satisfied before a consumer project can use the service.
Usage.Builder	addRequirementsBytes(com.google.protobuf.ByteString value) Requirements that must be satisfied before a consumer project can use the service.
Usage.Builder	addRules(int index, UsageRule.Builder builderForValue) A list of usage rules that apply to individual API methods.
Usage.Builder	addRules(int index, UsageRule value) A list of usage rules that apply to individual API methods.
Usage.Builder	addRules(UsageRule.Builder builderForValue) A list of usage rules that apply to individual API methods.
Usage.Builder	addRules(UsageRule value) A list of usage rules that apply to individual API methods.
UsageRule.Builder	addRulesBuilder() A list of usage rules that apply to individual API methods.
UsageRule.Builder	addRulesBuilder(int index) A list of usage rules that apply to individual API methods.
Usage	build()
Usage	buildPartial()
Usage.Builder	clear()
Usage.Builder	clearField(com.google.protobuf.Descriptors.FieldDescriptor field)
Usage.Builder	clearOneof(com.google.protobuf.Descriptors.OneofDescriptor oneof)
Usage.Builder	clearProducerNotificationChannel() The full resource name of a channel used for sending notifications to the service producer.
Usage.Builder	clearRequirements() Requirements that must be satisfied before a consumer project can use the service.
Usage.Builder	clearRules() A list of usage rules that apply to individual API methods.
Usage.Builder	clone()
Usage	getDefaultInstanceForType()
static com.google.protobuf.Descriptors.Descriptor	getDescriptor()
com.google.protobuf.Descriptors.Descriptor	getDescriptorForType()
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.
UsageRule.Builder	getRulesBuilder(int index) A list of usage rules that apply to individual API methods.
java.util.List<UsageRule.Builder>	getRulesBuilderList() 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.
protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable	internalGetFieldAccessorTable()
boolean	isInitialized()
Usage.Builder	mergeFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
Usage.Builder	mergeFrom(com.google.protobuf.Message other)
Usage.Builder	mergeFrom(Usage other)
Usage.Builder	mergeUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields)
Usage.Builder	removeRules(int index) A list of usage rules that apply to individual API methods.
Usage.Builder	setField(com.google.protobuf.Descriptors.FieldDescriptor field, java.lang.Object value)
Usage.Builder	setProducerNotificationChannel(java.lang.String value) The full resource name of a channel used for sending notifications to the service producer.
Usage.Builder	setProducerNotificationChannelBytes(com.google.protobuf.ByteString value) The full resource name of a channel used for sending notifications to the service producer.
Usage.Builder	setRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field, int index, java.lang.Object value)
Usage.Builder	setRequirements(int index, java.lang.String value) Requirements that must be satisfied before a consumer project can use the service.
Usage.Builder	setRules(int index, UsageRule.Builder builderForValue) A list of usage rules that apply to individual API methods.
Usage.Builder	setRules(int index, UsageRule value) A list of usage rules that apply to individual API methods.
Usage.Builder	setUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields)

Methods inherited from class com.google.protobuf.GeneratedMessageV3.Builder

getAllFields, getField, getFieldBuilder, getOneofFieldDescriptor, getParentForChildren, getRepeatedField, getRepeatedFieldBuilder, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof, internalGetMapField, internalGetMutableMapField, isClean, markClean, newBuilderForField, onBuilt, onChanged, setUnknownFieldsProto3

Methods inherited from class com.google.protobuf.AbstractMessage.Builder

findInitializationErrors, getInitializationErrorString, internalMergeFrom, mergeDelimitedFrom, mergeDelimitedFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, newUninitializedMessageException, toString

Methods inherited from class com.google.protobuf.AbstractMessageLite.Builder

addAll, addAll, mergeFrom, newUninitializedMessageException

Methods inherited from class java.lang.Object

equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.google.protobuf.MessageOrBuilder

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

Methods inherited from interface com.google.protobuf.MessageLite.Builder

mergeFrom

Method Detail

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.Builder<Usage.Builder>

clear

public Usage.Builder clear()

Specified by:

clear in interface com.google.protobuf.Message.Builder

Specified by:

clear in interface com.google.protobuf.MessageLite.Builder

Overrides:

clear in class com.google.protobuf.GeneratedMessageV3.Builder<Usage.Builder>

getDescriptorForType

public com.google.protobuf.Descriptors.Descriptor getDescriptorForType()

Specified by:

getDescriptorForType in interface com.google.protobuf.Message.Builder

Specified by:

getDescriptorForType in interface com.google.protobuf.MessageOrBuilder

Overrides:

getDescriptorForType in class com.google.protobuf.GeneratedMessageV3.Builder<Usage.Builder>

getDefaultInstanceForType

public Usage getDefaultInstanceForType()

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder

build

public Usage build()

Specified by:

build in interface com.google.protobuf.Message.Builder

Specified by:

build in interface com.google.protobuf.MessageLite.Builder

buildPartial

public Usage buildPartial()

Specified by:

buildPartial in interface com.google.protobuf.Message.Builder

Specified by:

buildPartial in interface com.google.protobuf.MessageLite.Builder

clone

public Usage.Builder clone()

Specified by:

clone in interface com.google.protobuf.Message.Builder

Specified by:

clone in interface com.google.protobuf.MessageLite.Builder

Overrides:

clone in class com.google.protobuf.GeneratedMessageV3.Builder<Usage.Builder>

setField

public Usage.Builder setField(com.google.protobuf.Descriptors.FieldDescriptor field,
                              java.lang.Object value)

Specified by:

setField in interface com.google.protobuf.Message.Builder

Overrides:

setField in class com.google.protobuf.GeneratedMessageV3.Builder<Usage.Builder>

clearField

public Usage.Builder clearField(com.google.protobuf.Descriptors.FieldDescriptor field)

Specified by:

clearField in interface com.google.protobuf.Message.Builder

Overrides:

clearField in class com.google.protobuf.GeneratedMessageV3.Builder<Usage.Builder>

clearOneof

public Usage.Builder clearOneof(com.google.protobuf.Descriptors.OneofDescriptor oneof)

Specified by:

clearOneof in interface com.google.protobuf.Message.Builder

Overrides:

clearOneof in class com.google.protobuf.GeneratedMessageV3.Builder<Usage.Builder>

setRepeatedField

public Usage.Builder setRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field,
                                      int index,
                                      java.lang.Object value)

Specified by:

setRepeatedField in interface com.google.protobuf.Message.Builder

Overrides:

setRepeatedField in class com.google.protobuf.GeneratedMessageV3.Builder<Usage.Builder>

addRepeatedField

public Usage.Builder addRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field,
                                      java.lang.Object value)

Specified by:

addRepeatedField in interface com.google.protobuf.Message.Builder

Overrides:

addRepeatedField in class com.google.protobuf.GeneratedMessageV3.Builder<Usage.Builder>

mergeFrom

public Usage.Builder mergeFrom(com.google.protobuf.Message other)

Specified by:

mergeFrom in interface com.google.protobuf.Message.Builder

Overrides:

mergeFrom in class com.google.protobuf.AbstractMessage.Builder<Usage.Builder>

mergeFrom

public Usage.Builder mergeFrom(Usage other)

isInitialized

public final boolean isInitialized()

Specified by:

isInitialized in interface com.google.protobuf.MessageLiteOrBuilder

Overrides:

isInitialized in class com.google.protobuf.GeneratedMessageV3.Builder<Usage.Builder>

mergeFrom

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

Specified by:

mergeFrom in interface com.google.protobuf.Message.Builder

Specified by:

mergeFrom in interface com.google.protobuf.MessageLite.Builder

Overrides:

mergeFrom in class com.google.protobuf.AbstractMessage.Builder<Usage.Builder>

Throws:

java.io.IOException

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

setRequirements

public Usage.Builder setRequirements(int index,
                                     java.lang.String value)

 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;

addRequirements

public Usage.Builder addRequirements(java.lang.String value)

 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;

addAllRequirements

public Usage.Builder addAllRequirements(java.lang.Iterable<java.lang.String> values)

 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;

clearRequirements

public Usage.Builder clearRequirements()

 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;

addRequirementsBytes

public Usage.Builder addRequirementsBytes(com.google.protobuf.ByteString value)

 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;

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

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

setRules

public Usage.Builder setRules(int index,
                              UsageRule value)

 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;

setRules

public Usage.Builder setRules(int index,
                              UsageRule.Builder builderForValue)

 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;

addRules

public Usage.Builder addRules(UsageRule value)

 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;

addRules

public Usage.Builder addRules(int index,
                              UsageRule value)

 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;

addRules

public Usage.Builder addRules(UsageRule.Builder builderForValue)

 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;

addRules

public Usage.Builder addRules(int index,
                              UsageRule.Builder builderForValue)

 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;

addAllRules

public Usage.Builder addAllRules(java.lang.Iterable<? extends UsageRule> values)

 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;

clearRules

public Usage.Builder clearRules()

 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;

removeRules

public Usage.Builder removeRules(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;

getRulesBuilder

public UsageRule.Builder getRulesBuilder(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;

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

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

addRulesBuilder

public UsageRule.Builder addRulesBuilder()

 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;

addRulesBuilder

public UsageRule.Builder addRulesBuilder(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;

getRulesBuilderList

public java.util.List<UsageRule.Builder> getRulesBuilderList()

 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

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

setProducerNotificationChannel

public Usage.Builder setProducerNotificationChannel(java.lang.String value)

 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;

clearProducerNotificationChannel

public Usage.Builder clearProducerNotificationChannel()

 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;

setProducerNotificationChannelBytes

public Usage.Builder setProducerNotificationChannelBytes(com.google.protobuf.ByteString value)

 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;

setUnknownFields

public final Usage.Builder setUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields)

Specified by:

setUnknownFields in interface com.google.protobuf.Message.Builder

Overrides:

setUnknownFields in class com.google.protobuf.GeneratedMessageV3.Builder<Usage.Builder>

mergeUnknownFields

public final Usage.Builder mergeUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields)

Specified by:

mergeUnknownFields in interface com.google.protobuf.Message.Builder

Overrides:

mergeUnknownFields in class com.google.protobuf.GeneratedMessageV3.Builder<Usage.Builder>