Class ServiceConfig (2.35.0)

public final class ServiceConfig extends GeneratedMessageV3 implements ServiceConfigOrBuilder

The configuration of the service.

Protobuf type google.api.serviceusage.v1beta1.ServiceConfig

Static Fields

APIS_FIELD_NUMBER

public static final int APIS_FIELD_NUMBER
Field Value
TypeDescription
int

AUTHENTICATION_FIELD_NUMBER

public static final int AUTHENTICATION_FIELD_NUMBER
Field Value
TypeDescription
int

DOCUMENTATION_FIELD_NUMBER

public static final int DOCUMENTATION_FIELD_NUMBER
Field Value
TypeDescription
int

ENDPOINTS_FIELD_NUMBER

public static final int ENDPOINTS_FIELD_NUMBER
Field Value
TypeDescription
int

MONITORED_RESOURCES_FIELD_NUMBER

public static final int MONITORED_RESOURCES_FIELD_NUMBER
Field Value
TypeDescription
int

MONITORING_FIELD_NUMBER

public static final int MONITORING_FIELD_NUMBER
Field Value
TypeDescription
int

NAME_FIELD_NUMBER

public static final int NAME_FIELD_NUMBER
Field Value
TypeDescription
int

QUOTA_FIELD_NUMBER

public static final int QUOTA_FIELD_NUMBER
Field Value
TypeDescription
int

TITLE_FIELD_NUMBER

public static final int TITLE_FIELD_NUMBER
Field Value
TypeDescription
int

USAGE_FIELD_NUMBER

public static final int USAGE_FIELD_NUMBER
Field Value
TypeDescription
int

Static Methods

getDefaultInstance()

public static ServiceConfig getDefaultInstance()
Returns
TypeDescription
ServiceConfig

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
TypeDescription
Descriptor

newBuilder()

public static ServiceConfig.Builder newBuilder()
Returns
TypeDescription
ServiceConfig.Builder

newBuilder(ServiceConfig prototype)

public static ServiceConfig.Builder newBuilder(ServiceConfig prototype)
Parameter
NameDescription
prototypeServiceConfig
Returns
TypeDescription
ServiceConfig.Builder

parseDelimitedFrom(InputStream input)

public static ServiceConfig parseDelimitedFrom(InputStream input)
Parameter
NameDescription
inputInputStream
Returns
TypeDescription
ServiceConfig
Exceptions
TypeDescription
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static ServiceConfig parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
ServiceConfig
Exceptions
TypeDescription
IOException

parseFrom(byte[] data)

public static ServiceConfig parseFrom(byte[] data)
Parameter
NameDescription
databyte[]
Returns
TypeDescription
ServiceConfig
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static ServiceConfig parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
databyte[]
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
ServiceConfig
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteString data)

public static ServiceConfig parseFrom(ByteString data)
Parameter
NameDescription
dataByteString
Returns
TypeDescription
ServiceConfig
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static ServiceConfig parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
dataByteString
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
ServiceConfig
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static ServiceConfig parseFrom(CodedInputStream input)
Parameter
NameDescription
inputCodedInputStream
Returns
TypeDescription
ServiceConfig
Exceptions
TypeDescription
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static ServiceConfig parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputCodedInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
ServiceConfig
Exceptions
TypeDescription
IOException

parseFrom(InputStream input)

public static ServiceConfig parseFrom(InputStream input)
Parameter
NameDescription
inputInputStream
Returns
TypeDescription
ServiceConfig
Exceptions
TypeDescription
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static ServiceConfig parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
ServiceConfig
Exceptions
TypeDescription
IOException

parseFrom(ByteBuffer data)

public static ServiceConfig parseFrom(ByteBuffer data)
Parameter
NameDescription
dataByteBuffer
Returns
TypeDescription
ServiceConfig
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static ServiceConfig parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
dataByteBuffer
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
ServiceConfig
Exceptions
TypeDescription
InvalidProtocolBufferException

parser()

public static Parser<ServiceConfig> parser()
Returns
TypeDescription
Parser<ServiceConfig>

Methods

equals(Object obj)

public boolean equals(Object obj)
Parameter
NameDescription
objObject
Returns
TypeDescription
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
NameDescription
indexint
Returns
TypeDescription
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
TypeDescription
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
TypeDescription
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
NameDescription
indexint
Returns
TypeDescription
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
TypeDescription
List<? extends com.google.protobuf.ApiOrBuilder>

getAuthentication()

public Authentication getAuthentication()

Auth configuration. Contains only the OAuth rules.

.google.api.Authentication authentication = 11;

Returns
TypeDescription
com.google.api.Authentication

The authentication.

getAuthenticationOrBuilder()

public AuthenticationOrBuilder getAuthenticationOrBuilder()

Auth configuration. Contains only the OAuth rules.

.google.api.Authentication authentication = 11;

Returns
TypeDescription
com.google.api.AuthenticationOrBuilder

getDefaultInstanceForType()

public ServiceConfig getDefaultInstanceForType()
Returns
TypeDescription
ServiceConfig

getDocumentation()

public Documentation getDocumentation()

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

.google.api.Documentation documentation = 6;

Returns
TypeDescription
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
TypeDescription
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
NameDescription
indexint
Returns
TypeDescription
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
TypeDescription
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
TypeDescription
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
NameDescription
indexint
Returns
TypeDescription
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
TypeDescription
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
NameDescription
indexint
Returns
TypeDescription
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
TypeDescription
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
TypeDescription
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
NameDescription
indexint
Returns
TypeDescription
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
TypeDescription
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
TypeDescription
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
TypeDescription
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
TypeDescription
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
TypeDescription
ByteString

The bytes for name.

getParserForType()

public Parser<ServiceConfig> getParserForType()
Returns
TypeDescription
Parser<ServiceConfig>
Overrides

getQuota()

public Quota getQuota()

Quota configuration.

.google.api.Quota quota = 10;

Returns
TypeDescription
com.google.api.Quota

The quota.

getQuotaOrBuilder()

public QuotaOrBuilder getQuotaOrBuilder()

Quota configuration.

.google.api.Quota quota = 10;

Returns
TypeDescription
com.google.api.QuotaOrBuilder

getSerializedSize()

public int getSerializedSize()
Returns
TypeDescription
int
Overrides

getTitle()

public String getTitle()

The product title for this service.

string title = 2;

Returns
TypeDescription
String

The title.

getTitleBytes()

public ByteString getTitleBytes()

The product title for this service.

string title = 2;

Returns
TypeDescription
ByteString

The bytes for title.

getUsage()

public Usage getUsage()

Configuration controlling usage of this service.

.google.api.Usage usage = 15;

Returns
TypeDescription
com.google.api.Usage

The usage.

getUsageOrBuilder()

public UsageOrBuilder getUsageOrBuilder()

Configuration controlling usage of this service.

.google.api.Usage usage = 15;

Returns
TypeDescription
com.google.api.UsageOrBuilder

hasAuthentication()

public boolean hasAuthentication()

Auth configuration. Contains only the OAuth rules.

.google.api.Authentication authentication = 11;

Returns
TypeDescription
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
TypeDescription
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
TypeDescription
boolean

Whether the monitoring field is set.

hasQuota()

public boolean hasQuota()

Quota configuration.

.google.api.Quota quota = 10;

Returns
TypeDescription
boolean

Whether the quota field is set.

hasUsage()

public boolean hasUsage()

Configuration controlling usage of this service.

.google.api.Usage usage = 15;

Returns
TypeDescription
boolean

Whether the usage field is set.

hashCode()

public int hashCode()
Returns
TypeDescription
int
Overrides

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
TypeDescription
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
TypeDescription
boolean
Overrides

newBuilderForType()

public ServiceConfig.Builder newBuilderForType()
Returns
TypeDescription
ServiceConfig.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected ServiceConfig.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
NameDescription
parentBuilderParent
Returns
TypeDescription
ServiceConfig.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
NameDescription
unusedUnusedPrivateParameter
Returns
TypeDescription
Object
Overrides

toBuilder()

public ServiceConfig.Builder toBuilder()
Returns
TypeDescription
ServiceConfig.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
NameDescription
outputCodedOutputStream
Overrides
Exceptions
TypeDescription
IOException