ServiceOrBuilder (java API)

All Superinterfaces:

MessageLiteOrBuilder, MessageOrBuilder

All Known Implementing Classes:

Service, Service.Builder
```
public interface ServiceOrBuilder
extends MessageOrBuilder
```

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method and Description
`Api`	`getApis(int index)` A list of API interfaces exported by this service.
`int`	`getApisCount()` A list of API interfaces exported by this service.
`java.util.List<Api>`	`getApisList()` A list of API interfaces exported by this service.
`ApiOrBuilder`	`getApisOrBuilder(int index)` A list of API interfaces exported by this service.
`java.util.List<? extends ApiOrBuilder>`	`getApisOrBuilderList()` A list of API interfaces exported by this service.
`Authentication`	`getAuthentication()` Auth configuration.
`AuthenticationOrBuilder`	`getAuthenticationOrBuilder()` Auth configuration.
`Backend`	`getBackend()` API backend configuration.
`BackendOrBuilder`	`getBackendOrBuilder()` API backend configuration.
`Billing`	`getBilling()` Billing configuration.
`BillingOrBuilder`	`getBillingOrBuilder()` Billing configuration.
`UInt32Value`	`getConfigVersion()` The semantic version of the service configuration.
`UInt32ValueOrBuilder`	`getConfigVersionOrBuilder()` The semantic version of the service configuration.
`Context`	`getContext()` Context configuration.
`ContextOrBuilder`	`getContextOrBuilder()` Context configuration.
`Control`	`getControl()` Configuration for the service control plane.
`ControlOrBuilder`	`getControlOrBuilder()` Configuration for the service control plane.
`Documentation`	`getDocumentation()` Additional API documentation.
`DocumentationOrBuilder`	`getDocumentationOrBuilder()` Additional API documentation.
`Endpoint`	`getEndpoints(int index)` Configuration for network endpoints.
`int`	`getEndpointsCount()` Configuration for network endpoints.
`java.util.List<Endpoint>`	`getEndpointsList()` Configuration for network endpoints.
`EndpointOrBuilder`	`getEndpointsOrBuilder(int index)` Configuration for network endpoints.
`java.util.List<? extends EndpointOrBuilder>`	`getEndpointsOrBuilderList()` Configuration for network endpoints.
`Enum`	`getEnums(int index)` A list of all enum types included in this API service.
`int`	`getEnumsCount()` A list of all enum types included in this API service.
`java.util.List<Enum>`	`getEnumsList()` A list of all enum types included in this API service.
`EnumOrBuilder`	`getEnumsOrBuilder(int index)` A list of all enum types included in this API service.
`java.util.List<? extends EnumOrBuilder>`	`getEnumsOrBuilderList()` A list of all enum types included in this API service.
`Http`	`getHttp()` HTTP configuration.
`HttpOrBuilder`	`getHttpOrBuilder()` HTTP configuration.
`java.lang.String`	`getId()` A unique ID for a specific instance of this message, typically assigned by the client for tracking purpose.
`ByteString`	`getIdBytes()` A unique ID for a specific instance of this message, typically assigned by the client for tracking purpose.
`Logging`	`getLogging()` Logging configuration.
`LoggingOrBuilder`	`getLoggingOrBuilder()` Logging configuration.
`LogDescriptor`	`getLogs(int index)` Defines the logs used by this service.
`int`	`getLogsCount()` Defines the logs used by this service.
`java.util.List<LogDescriptor>`	`getLogsList()` Defines the logs used by this service.
`LogDescriptorOrBuilder`	`getLogsOrBuilder(int index)` Defines the logs used by this service.
`java.util.List<? extends LogDescriptorOrBuilder>`	`getLogsOrBuilderList()` Defines the logs used by this service.
`MetricDescriptor`	`getMetrics(int index)` Defines the metrics used by this service.
`int`	`getMetricsCount()` Defines the metrics used by this service.
`java.util.List<MetricDescriptor>`	`getMetricsList()` Defines the metrics used by this service.
`MetricDescriptorOrBuilder`	`getMetricsOrBuilder(int index)` Defines the metrics used by this service.
`java.util.List<? extends MetricDescriptorOrBuilder>`	`getMetricsOrBuilderList()` Defines the metrics used by this service.
`MonitoredResourceDescriptor`	`getMonitoredResources(int index)` Defines the monitored resources used by this service.
`int`	`getMonitoredResourcesCount()` Defines the monitored resources used by this service.
`java.util.List<MonitoredResourceDescriptor>`	`getMonitoredResourcesList()` Defines the monitored resources used by this service.
`MonitoredResourceDescriptorOrBuilder`	`getMonitoredResourcesOrBuilder(int index)` Defines the monitored resources used by this service.
`java.util.List<? extends MonitoredResourceDescriptorOrBuilder>`	`getMonitoredResourcesOrBuilderList()` Defines the monitored resources used by this service.
`Monitoring`	`getMonitoring()` Monitoring configuration.
`MonitoringOrBuilder`	`getMonitoringOrBuilder()` Monitoring configuration.
`java.lang.String`	`getName()` The service name, which is a DNS-like logical identifier for the service, such as `calendar.googleapis.com`.
`ByteString`	`getNameBytes()` The service name, which is a DNS-like logical identifier for the service, such as `calendar.googleapis.com`.
`java.lang.String`	`getProducerProjectId()` The Google project that owns this service.
`ByteString`	`getProducerProjectIdBytes()` The Google project that owns this service.
`Quota`	`getQuota()` Quota configuration.
`QuotaOrBuilder`	`getQuotaOrBuilder()` Quota configuration.
`SourceInfo`	`getSourceInfo()` Output only.
`SourceInfoOrBuilder`	`getSourceInfoOrBuilder()` Output only.
`SystemParameters`	`getSystemParameters()` System parameter configuration.
`SystemParametersOrBuilder`	`getSystemParametersOrBuilder()` System parameter configuration.
`java.lang.String`	`getTitle()` The product title for this service.
`ByteString`	`getTitleBytes()` The product title for this service.
`Type`	`getTypes(int index)` A list of all proto message types included in this API service.
`int`	`getTypesCount()` A list of all proto message types included in this API service.
`java.util.List<Type>`	`getTypesList()` A list of all proto message types included in this API service.
`TypeOrBuilder`	`getTypesOrBuilder(int index)` A list of all proto message types included in this API service.
`java.util.List<? extends TypeOrBuilder>`	`getTypesOrBuilderList()` A list of all proto message types included in this API service.
`Usage`	`getUsage()` Configuration controlling usage of this service.
`UsageOrBuilder`	`getUsageOrBuilder()` Configuration controlling usage of this service.
`boolean`	`hasAuthentication()` Auth configuration.
`boolean`	`hasBackend()` API backend configuration.
`boolean`	`hasBilling()` Billing configuration.
`boolean`	`hasConfigVersion()` The semantic version of the service configuration.
`boolean`	`hasContext()` Context configuration.
`boolean`	`hasControl()` Configuration for the service control plane.
`boolean`	`hasDocumentation()` Additional API documentation.
`boolean`	`hasHttp()` HTTP configuration.
`boolean`	`hasLogging()` Logging configuration.
`boolean`	`hasMonitoring()` Monitoring configuration.
`boolean`	`hasQuota()` Quota configuration.
`boolean`	`hasSourceInfo()` Output only.
`boolean`	`hasSystemParameters()` System parameter configuration.
`boolean`	`hasUsage()` Configuration controlling usage of this service.

Methods inherited from interface com.google.protobuf.MessageOrBuilder
findInitializationErrors, getAllFields, getDefaultInstanceForType, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof

Methods inherited from interface com.google.protobuf.MessageLiteOrBuilder
isInitialized

Method Detail

hasConfigVersion

boolean hasConfigVersion()

 The semantic version of the service configuration. The config version
 affects the interpretation of the service configuration. For example,
 certain features are enabled by default for certain config versions.
 The latest config version is `3`.

.google.protobuf.UInt32Value config_version = 20;

getConfigVersion

UInt32Value getConfigVersion()

 The semantic version of the service configuration. The config version
 affects the interpretation of the service configuration. For example,
 certain features are enabled by default for certain config versions.
 The latest config version is `3`.

.google.protobuf.UInt32Value config_version = 20;

getConfigVersionOrBuilder

UInt32ValueOrBuilder getConfigVersionOrBuilder()

 The semantic version of the service configuration. The config version
 affects the interpretation of the service configuration. For example,
 certain features are enabled by default for certain config versions.
 The latest config version is `3`.

.google.protobuf.UInt32Value config_version = 20;

getName

java.lang.String getName()

 The service name, which is a DNS-like logical identifier for the
 service, such as `calendar.googleapis.com`. The service name
 typically goes through DNS verification to make sure the owner
 of the service also owns the DNS name.

string name = 1;

getNameBytes

ByteString getNameBytes()

 The service name, which is a DNS-like logical identifier for the
 service, such as `calendar.googleapis.com`. The service name
 typically goes through DNS verification to make sure the owner
 of the service also owns the DNS name.

string name = 1;

getId

java.lang.String getId()

 A unique ID for a specific instance of this message, typically assigned
 by the client for tracking purpose. If empty, the server may choose to
 generate one instead. Must be no longer than 60 characters.

string id = 33;

getIdBytes

ByteString getIdBytes()

 A unique ID for a specific instance of this message, typically assigned
 by the client for tracking purpose. If empty, the server may choose to
 generate one instead. Must be no longer than 60 characters.

string id = 33;

getTitle

java.lang.String getTitle()

 The product title for this service.

string title = 2;

getTitleBytes

ByteString getTitleBytes()

 The product title for this service.

string title = 2;

getProducerProjectId

java.lang.String getProducerProjectId()

 The Google project that owns this service.

string producer_project_id = 22;

getProducerProjectIdBytes

ByteString getProducerProjectIdBytes()

 The Google project that owns this service.

string producer_project_id = 22;

getApisList

java.util.List<Api> getApisList()

 A list of API interfaces exported by this service. Only the `name` field
 of the [google.protobuf.Api][google.protobuf.Api] needs to be provided by the configuration
 author, as the remaining fields will be derived from the IDL during the
 normalization process. It is an error to specify an API interface here
 which cannot be resolved against the associated IDL files.

repeated .google.protobuf.Api apis = 3;

getApis

Api getApis(int index)

 A list of API interfaces exported by this service. Only the `name` field
 of the [google.protobuf.Api][google.protobuf.Api] needs to be provided by the configuration
 author, as the remaining fields will be derived from the IDL during the
 normalization process. It is an error to specify an API interface here
 which cannot be resolved against the associated IDL files.

repeated .google.protobuf.Api apis = 3;

getApisCount

int getApisCount()

 A list of API interfaces exported by this service. Only the `name` field
 of the [google.protobuf.Api][google.protobuf.Api] needs to be provided by the configuration
 author, as the remaining fields will be derived from the IDL during the
 normalization process. It is an error to specify an API interface here
 which cannot be resolved against the associated IDL files.

repeated .google.protobuf.Api apis = 3;

getApisOrBuilderList

java.util.List<? extends ApiOrBuilder> getApisOrBuilderList()

 A list of API interfaces exported by this service. Only the `name` field
 of the [google.protobuf.Api][google.protobuf.Api] needs to be provided by the configuration
 author, as the remaining fields will be derived from the IDL during the
 normalization process. It is an error to specify an API interface here
 which cannot be resolved against the associated IDL files.

repeated .google.protobuf.Api apis = 3;

getApisOrBuilder

ApiOrBuilder getApisOrBuilder(int index)

 A list of API interfaces exported by this service. Only the `name` field
 of the [google.protobuf.Api][google.protobuf.Api] needs to be provided by the configuration
 author, as the remaining fields will be derived from the IDL during the
 normalization process. It is an error to specify an API interface here
 which cannot be resolved against the associated IDL files.

repeated .google.protobuf.Api apis = 3;

getTypesList

java.util.List<Type> getTypesList()

 A list of all proto message types included in this API service.
 Types referenced directly or indirectly by the `apis` are
 automatically included.  Messages which are not referenced but
 shall be included, such as types used by the `google.protobuf.Any` type,
 should be listed here by name. Example:
     types:
     - name: google.protobuf.Int32

repeated .google.protobuf.Type types = 4;

getTypes

Type getTypes(int index)

 A list of all proto message types included in this API service.
 Types referenced directly or indirectly by the `apis` are
 automatically included.  Messages which are not referenced but
 shall be included, such as types used by the `google.protobuf.Any` type,
 should be listed here by name. Example:
     types:
     - name: google.protobuf.Int32

repeated .google.protobuf.Type types = 4;

getTypesCount

int getTypesCount()

 A list of all proto message types included in this API service.
 Types referenced directly or indirectly by the `apis` are
 automatically included.  Messages which are not referenced but
 shall be included, such as types used by the `google.protobuf.Any` type,
 should be listed here by name. Example:
     types:
     - name: google.protobuf.Int32

repeated .google.protobuf.Type types = 4;

getTypesOrBuilderList

java.util.List<? extends TypeOrBuilder> getTypesOrBuilderList()

 A list of all proto message types included in this API service.
 Types referenced directly or indirectly by the `apis` are
 automatically included.  Messages which are not referenced but
 shall be included, such as types used by the `google.protobuf.Any` type,
 should be listed here by name. Example:
     types:
     - name: google.protobuf.Int32

repeated .google.protobuf.Type types = 4;

getTypesOrBuilder

TypeOrBuilder getTypesOrBuilder(int index)

 A list of all proto message types included in this API service.
 Types referenced directly or indirectly by the `apis` are
 automatically included.  Messages which are not referenced but
 shall be included, such as types used by the `google.protobuf.Any` type,
 should be listed here by name. Example:
     types:
     - name: google.protobuf.Int32

repeated .google.protobuf.Type types = 4;

getEnumsList

java.util.List<Enum> getEnumsList()

 A list of all enum types included in this API service.  Enums
 referenced directly or indirectly by the `apis` are automatically
 included.  Enums which are not referenced but shall be included
 should be listed here by name. Example:
     enums:
     - name: google.someapi.v1.SomeEnum

repeated .google.protobuf.Enum enums = 5;

getEnums

Enum getEnums(int index)

 A list of all enum types included in this API service.  Enums
 referenced directly or indirectly by the `apis` are automatically
 included.  Enums which are not referenced but shall be included
 should be listed here by name. Example:
     enums:
     - name: google.someapi.v1.SomeEnum

repeated .google.protobuf.Enum enums = 5;

getEnumsCount

int getEnumsCount()

 A list of all enum types included in this API service.  Enums
 referenced directly or indirectly by the `apis` are automatically
 included.  Enums which are not referenced but shall be included
 should be listed here by name. Example:
     enums:
     - name: google.someapi.v1.SomeEnum

repeated .google.protobuf.Enum enums = 5;

getEnumsOrBuilderList

java.util.List<? extends EnumOrBuilder> getEnumsOrBuilderList()

 A list of all enum types included in this API service.  Enums
 referenced directly or indirectly by the `apis` are automatically
 included.  Enums which are not referenced but shall be included
 should be listed here by name. Example:
     enums:
     - name: google.someapi.v1.SomeEnum

repeated .google.protobuf.Enum enums = 5;

getEnumsOrBuilder

EnumOrBuilder getEnumsOrBuilder(int index)

 A list of all enum types included in this API service.  Enums
 referenced directly or indirectly by the `apis` are automatically
 included.  Enums which are not referenced but shall be included
 should be listed here by name. Example:
     enums:
     - name: google.someapi.v1.SomeEnum

repeated .google.protobuf.Enum enums = 5;

hasDocumentation

boolean hasDocumentation()

 Additional API documentation.

.google.api.Documentation documentation = 6;

getDocumentation

Documentation getDocumentation()

 Additional API documentation.

.google.api.Documentation documentation = 6;

getDocumentationOrBuilder

DocumentationOrBuilder getDocumentationOrBuilder()

 Additional API documentation.

.google.api.Documentation documentation = 6;

hasBackend

boolean hasBackend()

 API backend configuration.

.google.api.Backend backend = 8;

getBackend

Backend getBackend()

 API backend configuration.

.google.api.Backend backend = 8;

getBackendOrBuilder

BackendOrBuilder getBackendOrBuilder()

 API backend configuration.

.google.api.Backend backend = 8;

hasHttp

boolean hasHttp()

 HTTP configuration.

.google.api.Http http = 9;

getHttp
```
Http getHttp()
```
```
 HTTP configuration.
 
```
.google.api.Http http = 9;

getHttpOrBuilder

HttpOrBuilder getHttpOrBuilder()

 HTTP configuration.

.google.api.Http http = 9;

hasQuota

boolean hasQuota()

 Quota configuration.

.google.api.Quota quota = 10;

getQuota

Quota getQuota()

 Quota configuration.

.google.api.Quota quota = 10;

getQuotaOrBuilder

QuotaOrBuilder getQuotaOrBuilder()

 Quota configuration.

.google.api.Quota quota = 10;

hasAuthentication
```
boolean hasAuthentication()
```
```
 Auth configuration.
 
```
.google.api.Authentication authentication = 11;

getAuthentication
```
Authentication getAuthentication()
```
```
 Auth configuration.
 
```
.google.api.Authentication authentication = 11;

getAuthenticationOrBuilder

AuthenticationOrBuilder getAuthenticationOrBuilder()

 Auth configuration.

.google.api.Authentication authentication = 11;

hasContext

boolean hasContext()

 Context configuration.

.google.api.Context context = 12;

getContext

Context getContext()

 Context configuration.

.google.api.Context context = 12;

getContextOrBuilder

ContextOrBuilder getContextOrBuilder()

 Context configuration.

.google.api.Context context = 12;

hasUsage

boolean hasUsage()

 Configuration controlling usage of this service.

.google.api.Usage usage = 15;

getUsage

Usage getUsage()

 Configuration controlling usage of this service.

.google.api.Usage usage = 15;

getUsageOrBuilder

UsageOrBuilder getUsageOrBuilder()

 Configuration controlling usage of this service.

.google.api.Usage usage = 15;

getEndpointsList

java.util.List<Endpoint> getEndpointsList()

 Configuration for network endpoints.  If this is empty, then an endpoint
 with the same name as the service is automatically generated to service all
 defined APIs.

repeated .google.api.Endpoint endpoints = 18;

getEndpoints

Endpoint getEndpoints(int index)

 Configuration for network endpoints.  If this is empty, then an endpoint
 with the same name as the service is automatically generated to service all
 defined APIs.

repeated .google.api.Endpoint endpoints = 18;

getEndpointsCount

int getEndpointsCount()

 Configuration for network endpoints.  If this is empty, then an endpoint
 with the same name as the service is automatically generated to service all
 defined APIs.

repeated .google.api.Endpoint endpoints = 18;

getEndpointsOrBuilderList

java.util.List<? extends EndpointOrBuilder> getEndpointsOrBuilderList()

 Configuration for network endpoints.  If this is empty, then an endpoint
 with the same name as the service is automatically generated to service all
 defined APIs.

repeated .google.api.Endpoint endpoints = 18;

getEndpointsOrBuilder

EndpointOrBuilder getEndpointsOrBuilder(int index)

 Configuration for network endpoints.  If this is empty, then an endpoint
 with the same name as the service is automatically generated to service all
 defined APIs.

repeated .google.api.Endpoint endpoints = 18;

hasControl

boolean hasControl()

 Configuration for the service control plane.

.google.api.Control control = 21;

getControl

Control getControl()

 Configuration for the service control plane.

.google.api.Control control = 21;

getControlOrBuilder

ControlOrBuilder getControlOrBuilder()

 Configuration for the service control plane.

.google.api.Control control = 21;

getLogsList

java.util.List<LogDescriptor> getLogsList()

 Defines the logs used by this service.

repeated .google.api.LogDescriptor logs = 23;

getLogs

LogDescriptor getLogs(int index)

 Defines the logs used by this service.

repeated .google.api.LogDescriptor logs = 23;

getLogsCount

int getLogsCount()

 Defines the logs used by this service.

repeated .google.api.LogDescriptor logs = 23;

getLogsOrBuilderList

java.util.List<? extends LogDescriptorOrBuilder> getLogsOrBuilderList()

 Defines the logs used by this service.

repeated .google.api.LogDescriptor logs = 23;

getLogsOrBuilder

LogDescriptorOrBuilder getLogsOrBuilder(int index)

 Defines the logs used by this service.

repeated .google.api.LogDescriptor logs = 23;