Class ServiceConfig (2.78.0)

publicfinalclass ServiceConfigextendsGeneratedMessageV3implementsServiceConfigOrBuilder

The configuration of the service.

Protobuf type google.api.serviceusage.v1.ServiceConfig

Inherited Members

com.google.protobuf.GeneratedMessageV3.<ListT>makeMutableCopy(ListT)
com.google.protobuf.GeneratedMessageV3.<ListT>makeMutableCopy(ListT,int)
com.google.protobuf.GeneratedMessageV3.<T>emptyList(java.lang.Class<T>)
com.google.protobuf.GeneratedMessageV3.internalGetMapFieldReflection(int)

Static Fields

APIS_FIELD_NUMBER

publicstaticfinalintAPIS_FIELD_NUMBER
Field Value
Type Description
int

AUTHENTICATION_FIELD_NUMBER

publicstaticfinalintAUTHENTICATION_FIELD_NUMBER
Field Value
Type Description
int

DOCUMENTATION_FIELD_NUMBER

publicstaticfinalintDOCUMENTATION_FIELD_NUMBER
Field Value
Type Description
int

ENDPOINTS_FIELD_NUMBER

publicstaticfinalintENDPOINTS_FIELD_NUMBER
Field Value
Type Description
int

MONITORED_RESOURCES_FIELD_NUMBER

publicstaticfinalintMONITORED_RESOURCES_FIELD_NUMBER
Field Value
Type Description
int

MONITORING_FIELD_NUMBER

publicstaticfinalintMONITORING_FIELD_NUMBER
Field Value
Type Description
int

NAME_FIELD_NUMBER

publicstaticfinalintNAME_FIELD_NUMBER
Field Value
Type Description
int

QUOTA_FIELD_NUMBER

publicstaticfinalintQUOTA_FIELD_NUMBER
Field Value
Type Description
int

TITLE_FIELD_NUMBER

publicstaticfinalintTITLE_FIELD_NUMBER
Field Value
Type Description
int

USAGE_FIELD_NUMBER

publicstaticfinalintUSAGE_FIELD_NUMBER
Field Value
Type Description
int

Static Methods

getDefaultInstance()

publicstaticServiceConfiggetDefaultInstance()
Returns
Type Description
ServiceConfig

getDescriptor()

publicstaticfinalDescriptors.DescriptorgetDescriptor()
Returns
Type Description
Descriptor

newBuilder()

publicstaticServiceConfig.BuildernewBuilder()
Returns
Type Description
ServiceConfig.Builder

newBuilder(ServiceConfig prototype)

publicstaticServiceConfig.BuildernewBuilder(ServiceConfigprototype)
Parameter
Name Description
prototype ServiceConfig
Returns
Type Description
ServiceConfig.Builder

parseDelimitedFrom(InputStream input)

publicstaticServiceConfigparseDelimitedFrom(InputStreaminput)
Parameter
Name Description
input InputStream
Returns
Type Description
ServiceConfig
Exceptions
Type Description
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

publicstaticServiceConfigparseDelimitedFrom(InputStreaminput,ExtensionRegistryLiteextensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
ServiceConfig
Exceptions
Type Description
IOException

parseFrom(byte[] data)

publicstaticServiceConfigparseFrom(byte[]data)
Parameter
Name Description
data byte[]
Returns
Type Description
ServiceConfig
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

publicstaticServiceConfigparseFrom(byte[]data,ExtensionRegistryLiteextensionRegistry)
Parameters
Name Description
data byte[]
extensionRegistry ExtensionRegistryLite
Returns
Type Description
ServiceConfig
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data)

publicstaticServiceConfigparseFrom(ByteStringdata)
Parameter
Name Description
data ByteString
Returns
Type Description
ServiceConfig
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

publicstaticServiceConfigparseFrom(ByteStringdata,ExtensionRegistryLiteextensionRegistry)
Parameters
Name Description
data ByteString
extensionRegistry ExtensionRegistryLite
Returns
Type Description
ServiceConfig
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

publicstaticServiceConfigparseFrom(CodedInputStreaminput)
Parameter
Name Description
input CodedInputStream
Returns
Type Description
ServiceConfig
Exceptions
Type Description
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

publicstaticServiceConfigparseFrom(CodedInputStreaminput,ExtensionRegistryLiteextensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
ServiceConfig
Exceptions
Type Description
IOException

parseFrom(InputStream input)

publicstaticServiceConfigparseFrom(InputStreaminput)
Parameter
Name Description
input InputStream
Returns
Type Description
ServiceConfig
Exceptions
Type Description
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

publicstaticServiceConfigparseFrom(InputStreaminput,ExtensionRegistryLiteextensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
ServiceConfig
Exceptions
Type Description
IOException

parseFrom(ByteBuffer data)

publicstaticServiceConfigparseFrom(ByteBufferdata)
Parameter
Name Description
data ByteBuffer
Returns
Type Description
ServiceConfig
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

publicstaticServiceConfigparseFrom(ByteBufferdata,ExtensionRegistryLiteextensionRegistry)
Parameters
Name Description
data ByteBuffer
extensionRegistry ExtensionRegistryLite
Returns
Type Description
ServiceConfig
Exceptions
Type Description
InvalidProtocolBufferException

parser()

publicstaticParser<ServiceConfig>parser()
Returns
Type Description
Parser<ServiceConfig>

Methods

equals(Object obj)

publicbooleanequals(Objectobj)
Parameter
Name Description
obj Object
Returns
Type Description
boolean
Overrides

getApis(int index)

publicApigetApis(intindex)

A list of API interfaces exported by this service. Contains only the names, versions, and method names of the interfaces.

repeated .google.protobuf.Api apis = 3;

Parameter
Name Description
index int
Returns
Type Description
Api

getApisCount()

publicintgetApisCount()

A list of API interfaces exported by this service. Contains only the names, versions, and method names of the interfaces.

repeated .google.protobuf.Api apis = 3;

Returns
Type Description
int

getApisList()

publicList<Api>getApisList()

A list of API interfaces exported by this service. Contains only the names, versions, and method names of the interfaces.

repeated .google.protobuf.Api apis = 3;

Returns
Type Description
List<Api>

getApisOrBuilder(int index)

publicApiOrBuildergetApisOrBuilder(intindex)

A list of API interfaces exported by this service. Contains only the names, versions, and method names of the interfaces.

repeated .google.protobuf.Api apis = 3;

Parameter
Name Description
index int
Returns
Type Description
ApiOrBuilder

getApisOrBuilderList()

publicList<?extendsApiOrBuilder>getApisOrBuilderList()

A list of API interfaces exported by this service. Contains only the names, versions, and method names of the interfaces.

repeated .google.protobuf.Api apis = 3;

Returns
Type Description
List<? extends com.google.protobuf.ApiOrBuilder>

getAuthentication()

publicAuthenticationgetAuthentication()

Auth configuration. Contains only the OAuth rules.

.google.api.Authentication authentication = 11;

Returns
Type Description
com.google.api.Authentication

The authentication.

getAuthenticationOrBuilder()

publicAuthenticationOrBuildergetAuthenticationOrBuilder()

Auth configuration. Contains only the OAuth rules.

.google.api.Authentication authentication = 11;

Returns
Type Description
com.google.api.AuthenticationOrBuilder

getDefaultInstanceForType()

publicServiceConfiggetDefaultInstanceForType()
Returns
Type Description
ServiceConfig

getDocumentation()

publicDocumentationgetDocumentation()

Additional API documentation. Contains only the summary and the documentation URL.

.google.api.Documentation documentation = 6;

Returns
Type Description
com.google.api.Documentation

The documentation.

getDocumentationOrBuilder()

publicDocumentationOrBuildergetDocumentationOrBuilder()

Additional API documentation. Contains only the summary and the documentation URL.

.google.api.Documentation documentation = 6;

Returns
Type Description
com.google.api.DocumentationOrBuilder

getEndpoints(int index)

publicEndpointgetEndpoints(intindex)

Configuration for network endpoints. Contains only the names and aliases of the endpoints.

repeated .google.api.Endpoint endpoints = 18;

Parameter
Name Description
index int
Returns
Type Description
com.google.api.Endpoint

getEndpointsCount()

publicintgetEndpointsCount()

Configuration for network endpoints. Contains only the names and aliases of the endpoints.

repeated .google.api.Endpoint endpoints = 18;

Returns
Type Description
int

getEndpointsList()

publicList<Endpoint>getEndpointsList()

Configuration for network endpoints. Contains only the names and aliases of the endpoints.

repeated .google.api.Endpoint endpoints = 18;

Returns
Type Description
List<com.google.api.Endpoint>

getEndpointsOrBuilder(int index)

publicEndpointOrBuildergetEndpointsOrBuilder(intindex)

Configuration for network endpoints. Contains only the names and aliases of the endpoints.

repeated .google.api.Endpoint endpoints = 18;

Parameter
Name Description
index int
Returns
Type Description
com.google.api.EndpointOrBuilder

getEndpointsOrBuilderList()

publicList<?extendsEndpointOrBuilder>getEndpointsOrBuilderList()

Configuration for network endpoints. Contains only the names and aliases of the endpoints.

repeated .google.api.Endpoint endpoints = 18;

Returns
Type Description
List<? extends com.google.api.EndpointOrBuilder>

getMonitoredResources(int index)

publicMonitoredResourceDescriptorgetMonitoredResources(intindex)

Defines the monitored resources used by this service. This is required by the Service.monitoring and Service.logging configurations.

repeated .google.api.MonitoredResourceDescriptor monitored_resources = 25;

Parameter
Name Description
index int
Returns
Type Description
com.google.api.MonitoredResourceDescriptor

getMonitoredResourcesCount()

publicintgetMonitoredResourcesCount()

Defines the monitored resources used by this service. This is required by the Service.monitoring and Service.logging configurations.

repeated .google.api.MonitoredResourceDescriptor monitored_resources = 25;

Returns
Type Description
int

getMonitoredResourcesList()

publicList<MonitoredResourceDescriptor>getMonitoredResourcesList()

Defines the monitored resources used by this service. This is required by the Service.monitoring and Service.logging configurations.

repeated .google.api.MonitoredResourceDescriptor monitored_resources = 25;

Returns
Type Description
List<com.google.api.MonitoredResourceDescriptor>

getMonitoredResourcesOrBuilder(int index)

publicMonitoredResourceDescriptorOrBuildergetMonitoredResourcesOrBuilder(intindex)

Defines the monitored resources used by this service. This is required by the Service.monitoring and Service.logging configurations.

repeated .google.api.MonitoredResourceDescriptor monitored_resources = 25;

Parameter
Name Description
index int
Returns
Type Description
com.google.api.MonitoredResourceDescriptorOrBuilder

getMonitoredResourcesOrBuilderList()

publicList<?extendsMonitoredResourceDescriptorOrBuilder>getMonitoredResourcesOrBuilderList()

Defines the monitored resources used by this service. This is required by the Service.monitoring and Service.logging configurations.

repeated .google.api.MonitoredResourceDescriptor monitored_resources = 25;

Returns
Type Description
List<? extends com.google.api.MonitoredResourceDescriptorOrBuilder>

getMonitoring()

publicMonitoringgetMonitoring()

Monitoring configuration. This should not include the 'producer_destinations' field.

.google.api.Monitoring monitoring = 28;

Returns
Type Description
com.google.api.Monitoring

The monitoring.

getMonitoringOrBuilder()

publicMonitoringOrBuildergetMonitoringOrBuilder()

Monitoring configuration. This should not include the 'producer_destinations' field.

.google.api.Monitoring monitoring = 28;

Returns
Type Description
com.google.api.MonitoringOrBuilder

getName()

publicStringgetName()

The DNS address at which this service is available.

An example DNS address would be: calendar.googleapis.com.

string name = 1;

Returns
Type Description
String

The name.

getNameBytes()

publicByteStringgetNameBytes()

The DNS address at which this service is available.

An example DNS address would be: calendar.googleapis.com.

string name = 1;

Returns
Type Description
ByteString

The bytes for name.

getParserForType()

publicParser<ServiceConfig>getParserForType()
Returns
Type Description
Parser<ServiceConfig>
Overrides

getQuota()

publicQuotagetQuota()

Quota configuration.

.google.api.Quota quota = 10;

Returns
Type Description
com.google.api.Quota

The quota.

getQuotaOrBuilder()

publicQuotaOrBuildergetQuotaOrBuilder()

Quota configuration.

.google.api.Quota quota = 10;

Returns
Type Description
com.google.api.QuotaOrBuilder

getSerializedSize()

publicintgetSerializedSize()
Returns
Type Description
int
Overrides

getTitle()

publicStringgetTitle()

The product title for this service.

string title = 2;

Returns
Type Description
String

The title.

getTitleBytes()

publicByteStringgetTitleBytes()

The product title for this service.

string title = 2;

Returns
Type Description
ByteString

The bytes for title.

getUsage()

publicUsagegetUsage()

Configuration controlling usage of this service.

.google.api.Usage usage = 15;

Returns
Type Description
com.google.api.Usage

The usage.

getUsageOrBuilder()

publicUsageOrBuildergetUsageOrBuilder()

Configuration controlling usage of this service.

.google.api.Usage usage = 15;

Returns
Type Description
com.google.api.UsageOrBuilder

hasAuthentication()

publicbooleanhasAuthentication()

Auth configuration. Contains only the OAuth rules.

.google.api.Authentication authentication = 11;

Returns
Type Description
boolean

Whether the authentication field is set.

hasDocumentation()

publicbooleanhasDocumentation()

Additional API documentation. Contains only the summary and the documentation URL.

.google.api.Documentation documentation = 6;

Returns
Type Description
boolean

Whether the documentation field is set.

hasMonitoring()

publicbooleanhasMonitoring()

Monitoring configuration. This should not include the 'producer_destinations' field.

.google.api.Monitoring monitoring = 28;

Returns
Type Description
boolean

Whether the monitoring field is set.

hasQuota()

publicbooleanhasQuota()

Quota configuration.

.google.api.Quota quota = 10;

Returns
Type Description
boolean

Whether the quota field is set.

hasUsage()

publicbooleanhasUsage()

Configuration controlling usage of this service.

.google.api.Usage usage = 15;

Returns
Type Description
boolean

Whether the usage field is set.

hashCode()

publicinthashCode()
Returns
Type Description
int
Overrides

internalGetFieldAccessorTable()

protectedGeneratedMessageV3.FieldAccessorTableinternalGetFieldAccessorTable()
Returns
Type Description
FieldAccessorTable
Overrides

isInitialized()

publicfinalbooleanisInitialized()
Returns
Type Description
boolean
Overrides

newBuilderForType()

publicServiceConfig.BuildernewBuilderForType()
Returns
Type Description
ServiceConfig.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protectedServiceConfig.BuildernewBuilderForType(GeneratedMessageV3.BuilderParentparent)
Parameter
Name Description
parent BuilderParent
Returns
Type Description
ServiceConfig.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protectedObjectnewInstance(GeneratedMessageV3.UnusedPrivateParameterunused)
Parameter
Name Description
unused UnusedPrivateParameter
Returns
Type Description
Object
Overrides

toBuilder()

publicServiceConfig.BuildertoBuilder()
Returns
Type Description
ServiceConfig.Builder

writeTo(CodedOutputStream output)

publicvoidwriteTo(CodedOutputStreamoutput)
Parameter
Name Description
output CodedOutputStream
Overrides
Exceptions
Type Description
IOException

Except as otherwise noted, the content of this page is licensed under the Creative Commons Attribution 4.0 License, and code samples are licensed under the Apache 2.0 License. For details, see the Google Developers Site Policies. Java is a registered trademark of Oracle and/or its affiliates.

Last updated 2025年11月19日 UTC.