public final class Usage extends GeneratedMessageV3 implements UsageOrBuilder
Configuration controlling usage of a service.
Protobuf type google.api.Usage
Static Fields
PRODUCER_NOTIFICATION_CHANNEL_FIELD_NUMBER
public static final int PRODUCER_NOTIFICATION_CHANNEL_FIELD_NUMBER
Field Value
REQUIREMENTS_FIELD_NUMBER
public static final int REQUIREMENTS_FIELD_NUMBER
Field Value
RULES_FIELD_NUMBER
public static final int RULES_FIELD_NUMBER
Field Value
Static Methods
getDefaultInstance()
public static Usage getDefaultInstance()
Returns
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()
Returns
newBuilder()
public static Usage.Builder newBuilder()
Returns
newBuilder(Usage prototype)
public static Usage.Builder newBuilder(Usage prototype)
Parameter
| Name | Description |
| prototype | Usage
|
Returns
public static Usage parseDelimitedFrom(InputStream input)
Parameter
Returns
Exceptions
public static Usage parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
parseFrom(byte[] data)
public static Usage parseFrom(byte[] data)
Parameter
| Name | Description |
| data | byte[]
|
Returns
Exceptions
parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
public static Usage parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
parseFrom(ByteString data)
public static Usage parseFrom(ByteString data)
Parameter
Returns
Exceptions
parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static Usage parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
public static Usage parseFrom(CodedInputStream input)
Parameter
Returns
Exceptions
public static Usage parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
public static Usage parseFrom(InputStream input)
Parameter
Returns
Exceptions
public static Usage parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
parseFrom(ByteBuffer data)
public static Usage parseFrom(ByteBuffer data)
Parameter
Returns
Exceptions
parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
public static Usage parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
parser()
public static Parser<Usage> parser()
Returns
Methods
equals(Object obj)
public boolean equals(Object obj)
Parameter
Returns
Overrides
getDefaultInstanceForType()
public Usage getDefaultInstanceForType()
Returns
getParserForType()
public Parser<Usage> getParserForType()
Returns
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;
| 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;
| 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;
| 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;
| 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;
| 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;
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;
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;
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;
| Type | Description |
| List<? extends com.google.api.UsageRuleOrBuilder> | |
getSerializedSize()
public int getSerializedSize()
Returns
Overrides
getUnknownFields()
public final UnknownFieldSet getUnknownFields()
Returns
Overrides
hashCode()
Returns
Overrides
internalGetFieldAccessorTable()
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Overrides
isInitialized()
public final boolean isInitialized()
Returns
Overrides
newBuilderForType()
public Usage.Builder newBuilderForType()
Returns
newBuilderForType(GeneratedMessageV3.BuilderParent parent)
protected Usage.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
Returns
Overrides
newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
Returns
Overrides
toBuilder()
public Usage.Builder toBuilder()
Returns
writeTo(CodedOutputStream output)
public void writeTo(CodedOutputStream output)
Parameter
Overrides
Exceptions
