Class Usage (2.24.0) 

public final class Usage extends GeneratedMessageV3 implements UsageOrBuilder

Configuration controlling usage of a service.

Protobuf type google.api.Usage

Inheritance

Object > AbstractMessageLite<MessageType,BuilderType> > AbstractMessage > GeneratedMessageV3 > Usage

Implements

UsageOrBuilder

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()
Returns
Type Description
Descriptor

newBuilder()

public static Usage.Builder newBuilder()
Returns
Type Description
Usage.Builder

newBuilder(Usage prototype)

public static Usage.Builder newBuilder(Usage prototype)
Parameter
Name Description
prototype Usage
Returns
Type Description
Usage.Builder

parseDelimitedFrom(InputStream input)

public static Usage parseDelimitedFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
Usage
Exceptions
Type Description
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static Usage parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
Usage
Exceptions
Type Description
IOException

parseFrom(byte[] data)

public static Usage parseFrom(byte[] data)
Parameter
Name Description
data byte[]
Returns
Type Description
Usage
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static Usage parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data byte[]
extensionRegistry ExtensionRegistryLite
Returns
Type Description
Usage
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data)

public static Usage parseFrom(ByteString data)
Parameter
Name Description
data ByteString
Returns
Type Description
Usage
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static Usage parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteString
extensionRegistry ExtensionRegistryLite
Returns
Type Description
Usage
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static Usage parseFrom(CodedInputStream input)
Parameter
Name Description
input CodedInputStream
Returns
Type Description
Usage
Exceptions
Type Description
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static Usage parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
Usage
Exceptions
Type Description
IOException

parseFrom(InputStream input)

public static Usage parseFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
Usage
Exceptions
Type Description
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static Usage parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
Usage
Exceptions
Type Description
IOException

parseFrom(ByteBuffer data)

public static Usage parseFrom(ByteBuffer data)
Parameter
Name Description
data ByteBuffer
Returns
Type Description
Usage
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static Usage parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteBuffer
extensionRegistry ExtensionRegistryLite
Returns
Type Description
Usage
Exceptions
Type Description
InvalidProtocolBufferException

parser()

public static Parser<Usage> parser()
Returns
Type Description
Parser<Usage>

Methods

equals(Object obj)

public boolean equals(Object obj)
Parameter
Name Description
obj Object
Returns
Type Description
boolean
Overrides

getDefaultInstanceForType()

public Usage getDefaultInstanceForType()
Returns
Type Description
Usage

getParserForType()

public Parser<Usage> getParserForType()
Returns
Type Description
Parser<Usage>
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;

Returns
Type Description
ProtocolStringList

A list containing the requirements.

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
Returns
Type Description
UsageRule

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;

Returns
Type Description
List<UsageRule>

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
Returns
Type Description
UsageRuleOrBuilder

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()

public int hashCode()
Returns
Type Description
int
Overrides

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Type Description
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

newBuilderForType()

public Usage.Builder newBuilderForType()
Returns
Type Description
Usage.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected Usage.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
Name Description
parent BuilderParent
Returns
Type Description
Usage.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
Name Description
unused UnusedPrivateParameter
Returns
Type Description
Object
Overrides

toBuilder()

public Usage.Builder toBuilder()
Returns
Type Description
Usage.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
Name Description
output CodedOutputStream
Overrides
Exceptions
Type Description
IOException