Class ServiceConfig (2.52.0)

public final class ServiceConfig extends GeneratedMessageV3 implements ServiceConfigOrBuilder

The configuration of the service.

Protobuf type google.api.serviceusage.v1.ServiceConfig

Static Fields

APIS_FIELD_NUMBER

public static final int APIS_FIELD_NUMBER
Field Value
Type Description
int

AUTHENTICATION_FIELD_NUMBER

public static final int AUTHENTICATION_FIELD_NUMBER
Field Value
Type Description
int

DOCUMENTATION_FIELD_NUMBER

public static final int DOCUMENTATION_FIELD_NUMBER
Field Value
Type Description
int

ENDPOINTS_FIELD_NUMBER

public static final int ENDPOINTS_FIELD_NUMBER
Field Value
Type Description
int

MONITORED_RESOURCES_FIELD_NUMBER

public static final int MONITORED_RESOURCES_FIELD_NUMBER
Field Value
Type Description
int

MONITORING_FIELD_NUMBER

public static final int MONITORING_FIELD_NUMBER
Field Value
Type Description
int

NAME_FIELD_NUMBER

public static final int NAME_FIELD_NUMBER
Field Value
Type Description
int

QUOTA_FIELD_NUMBER

public static final int QUOTA_FIELD_NUMBER
Field Value
Type Description
int

TITLE_FIELD_NUMBER

public static final int TITLE_FIELD_NUMBER
Field Value
Type Description
int

USAGE_FIELD_NUMBER

public static final int USAGE_FIELD_NUMBER
Field Value
Type Description
int

Static Methods

getDefaultInstance()

public static ServiceConfig getDefaultInstance()
Returns
Type Description
ServiceConfig

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
Type Description
Descriptor

newBuilder()

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

newBuilder(ServiceConfig prototype)

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

parseDelimitedFrom(InputStream input)

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

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(byte[] data)

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

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteString data)

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

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(CodedInputStream input)

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

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(InputStream input)

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

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteBuffer data)

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

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

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

parser()

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

Methods

equals(Object obj)

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

getApis(int index)

public Api getApis(int index)

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

public int getApisCount()

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

public List<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)

public ApiOrBuilder getApisOrBuilder(int index)

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

public List<? extends ApiOrBuilder> 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()

public Authentication getAuthentication()

Auth configuration. Contains only the OAuth rules.

.google.api.Authentication authentication = 11;

Returns
Type Description
com.google.api.Authentication

The authentication.

getAuthenticationOrBuilder()

public AuthenticationOrBuilder getAuthenticationOrBuilder()

Auth configuration. Contains only the OAuth rules.

.google.api.Authentication authentication = 11;

Returns
Type Description
com.google.api.AuthenticationOrBuilder

getDefaultInstanceForType()

public ServiceConfig getDefaultInstanceForType()
Returns
Type Description
ServiceConfig

getDocumentation()

public Documentation getDocumentation()

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

public DocumentationOrBuilder getDocumentationOrBuilder()

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)

public Endpoint getEndpoints(int index)

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

public int getEndpointsCount()

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

repeated .google.api.Endpoint endpoints = 18;

Returns
Type Description
int

getEndpointsList()

public List<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)

public EndpointOrBuilder getEndpointsOrBuilder(int index)

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

public List<? extends EndpointOrBuilder> 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)

public MonitoredResourceDescriptor getMonitoredResources(int index)

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

public int getMonitoredResourcesCount()

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

public List<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)

public MonitoredResourceDescriptorOrBuilder getMonitoredResourcesOrBuilder(int index)

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

public List<? extends MonitoredResourceDescriptorOrBuilder> 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()

public Monitoring getMonitoring()

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

public MonitoringOrBuilder getMonitoringOrBuilder()

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

.google.api.Monitoring monitoring = 28;

Returns
Type Description
com.google.api.MonitoringOrBuilder

getName()

public String getName()

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

public ByteString getNameBytes()

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

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

getQuota()

public Quota getQuota()

Quota configuration.

.google.api.Quota quota = 10;

Returns
Type Description
com.google.api.Quota

The quota.

getQuotaOrBuilder()

public QuotaOrBuilder getQuotaOrBuilder()

Quota configuration.

.google.api.Quota quota = 10;

Returns
Type Description
com.google.api.QuotaOrBuilder

getSerializedSize()

public int getSerializedSize()
Returns
Type Description
int
Overrides

getTitle()

public String getTitle()

The product title for this service.

string title = 2;

Returns
Type Description
String

The title.

getTitleBytes()

public ByteString getTitleBytes()

The product title for this service.

string title = 2;

Returns
Type Description
ByteString

The bytes for title.

getUsage()

public Usage getUsage()

Configuration controlling usage of this service.

.google.api.Usage usage = 15;

Returns
Type Description
com.google.api.Usage

The usage.

getUsageOrBuilder()

public UsageOrBuilder getUsageOrBuilder()

Configuration controlling usage of this service.

.google.api.Usage usage = 15;

Returns
Type Description
com.google.api.UsageOrBuilder

hasAuthentication()

public boolean hasAuthentication()

Auth configuration. Contains only the OAuth rules.

.google.api.Authentication authentication = 11;

Returns
Type Description
boolean

Whether the authentication field is set.

hasDocumentation()

public boolean hasDocumentation()

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

public boolean hasMonitoring()

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

public boolean hasQuota()

Quota configuration.

.google.api.Quota quota = 10;

Returns
Type Description
boolean

Whether the quota field is set.

hasUsage()

public boolean hasUsage()

Configuration controlling usage of this service.

.google.api.Usage usage = 15;

Returns
Type Description
boolean

Whether the usage field is set.

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 ServiceConfig.Builder newBuilderForType()
Returns
Type Description
ServiceConfig.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

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

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

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

toBuilder()

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

writeTo(CodedOutputStream output)

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