public final class Service extends GeneratedMessageV3 implements ServiceOrBuilder
Service is the root object of Google API service configuration (service
config). It describes the basic information about a logical service,
such as the service name and the user-facing title, and delegates other
aspects to sub-sections. Each sub-section is either a proto message or a
repeated proto message that configures a specific aspect, such as auth.
For more information, see each proto message definition.
Example:
type: google.api.Service
name: calendar.googleapis.com
title: Google Calendar API
apis:
- name: google.calendar.v3.Calendar
visibility:
rules:
Protobuf type google.api.Service
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 |
|
BACKEND_FIELD_NUMBER
public static final int BACKEND_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
BILLING_FIELD_NUMBER
public static final int BILLING_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
CONFIG_VERSION_FIELD_NUMBER
public static final int CONFIG_VERSION_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
CONTEXT_FIELD_NUMBER
public static final int CONTEXT_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
CONTROL_FIELD_NUMBER
public static final int CONTROL_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 |
|
ENUMS_FIELD_NUMBER
public static final int ENUMS_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
HTTP_FIELD_NUMBER
public static final int HTTP_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
ID_FIELD_NUMBER
public static final int ID_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
LOGGING_FIELD_NUMBER
public static final int LOGGING_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
LOGS_FIELD_NUMBER
public static final int LOGS_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
METRICS_FIELD_NUMBER
public static final int METRICS_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 |
|
PRODUCER_PROJECT_ID_FIELD_NUMBER
public static final int PRODUCER_PROJECT_ID_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
PUBLISHING_FIELD_NUMBER
public static final int PUBLISHING_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
QUOTA_FIELD_NUMBER
public static final int QUOTA_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
SOURCE_INFO_FIELD_NUMBER
public static final int SOURCE_INFO_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
SYSTEM_PARAMETERS_FIELD_NUMBER
public static final int SYSTEM_PARAMETERS_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
TITLE_FIELD_NUMBER
public static final int TITLE_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
TYPES_FIELD_NUMBER
public static final int TYPES_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 Service getDefaultInstance()
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()
newBuilder()
public static Service.Builder newBuilder()
newBuilder(Service prototype)
public static Service.Builder newBuilder(Service prototype)
| Parameter |
| Name |
Description |
prototype |
Service
|
public static Service parseDelimitedFrom(InputStream input)
public static Service parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
parseFrom(byte[] data)
public static Service parseFrom(byte[] data)
| Parameter |
| Name |
Description |
data |
byte[]
|
parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
public static Service parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
parseFrom(ByteString data)
public static Service parseFrom(ByteString data)
parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static Service parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static Service parseFrom(CodedInputStream input)
public static Service parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
public static Service parseFrom(InputStream input)
public static Service parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
parseFrom(ByteBuffer data)
public static Service parseFrom(ByteBuffer data)
parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
public static Service parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
parser()
public static Parser<Service> parser()
Methods
equals(Object obj)
public boolean equals(Object obj)
| Parameter |
| Name |
Description |
obj |
Object
|
Overrides
getApis(int index)
public Api getApis(int index)
A list of API interfaces exported by this service. Only the name field
of the 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;
| Parameter |
| Name |
Description |
index |
int
|
| Returns |
| Type |
Description |
Api |
|
getApisCount()
public int getApisCount()
A list of API interfaces exported by this service. Only the name field
of the 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;
| Returns |
| Type |
Description |
int |
|
getApisList()
public List<Api> getApisList()
A list of API interfaces exported by this service. Only the name field
of the 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(int index)
public ApiOrBuilder getApisOrBuilder(int index)
A list of API interfaces exported by this service. Only the name field
of the 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;
| Parameter |
| Name |
Description |
index |
int
|
getApisOrBuilderList()
public List<? extends ApiOrBuilder> getApisOrBuilderList()
A list of API interfaces exported by this service. Only the name field
of the 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;
| Returns |
| Type |
Description |
List<? extends com.google.protobuf.ApiOrBuilder> |
|
getAuthentication()
public Authentication getAuthentication()
Auth configuration.
.google.api.Authentication authentication = 11;
getAuthenticationOrBuilder()
public AuthenticationOrBuilder getAuthenticationOrBuilder()
Auth configuration.
.google.api.Authentication authentication = 11;
getBackend()
public Backend getBackend()
API backend configuration.
.google.api.Backend backend = 8;
| Returns |
| Type |
Description |
Backend |
The backend.
|
getBackendOrBuilder()
public BackendOrBuilder getBackendOrBuilder()
API backend configuration.
.google.api.Backend backend = 8;
getBilling()
public Billing getBilling()
Billing configuration.
.google.api.Billing billing = 26;
| Returns |
| Type |
Description |
Billing |
The billing.
|
getBillingOrBuilder()
public BillingOrBuilder getBillingOrBuilder()
Billing configuration.
.google.api.Billing billing = 26;
getConfigVersion()
public UInt32Value getConfigVersion()
Obsolete. Do not use.
This field has no semantic meaning. The service config compiler always
sets this field to 3.
.google.protobuf.UInt32Value config_version = 20;
| Returns |
| Type |
Description |
UInt32Value |
The configVersion.
|
getConfigVersionOrBuilder()
public UInt32ValueOrBuilder getConfigVersionOrBuilder()
Obsolete. Do not use.
This field has no semantic meaning. The service config compiler always
sets this field to 3.
.google.protobuf.UInt32Value config_version = 20;
getContext()
public Context getContext()
Context configuration.
.google.api.Context context = 12;
| Returns |
| Type |
Description |
Context |
The context.
|
getContextOrBuilder()
public ContextOrBuilder getContextOrBuilder()
Context configuration.
.google.api.Context context = 12;
getControl()
public Control getControl()
Configuration for the service control plane.
.google.api.Control control = 21;
| Returns |
| Type |
Description |
Control |
The control.
|
getControlOrBuilder()
public ControlOrBuilder getControlOrBuilder()
Configuration for the service control plane.
.google.api.Control control = 21;
getDefaultInstanceForType()
public Service getDefaultInstanceForType()
getDocumentation()
public Documentation getDocumentation()
Additional API documentation.
.google.api.Documentation documentation = 6;
getDocumentationOrBuilder()
public DocumentationOrBuilder getDocumentationOrBuilder()
Additional API documentation.
.google.api.Documentation documentation = 6;
getEndpoints(int index)
public 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;
| Parameter |
| Name |
Description |
index |
int
|
getEndpointsCount()
public 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;
| Returns |
| Type |
Description |
int |
|
getEndpointsList()
public 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;