- 2.61.0 (latest)
- 2.60.0
- 2.59.2
- 2.58.0
- 2.57.0
- 2.56.0
- 2.54.1
- 2.53.0
- 2.52.0
- 2.51.0
- 2.50.1
- 2.49.0
- 2.48.0
- 2.46.0
- 2.45.1
- 2.44.0
- 2.43.0
- 2.42.0
- 2.41.0
- 2.40.0
- 2.39.1
- 2.38.0
- 2.37.1
- 2.36.0
- 2.34.0
- 2.33.0
- 2.32.0
- 2.30.0
- 2.29.0
- 2.28.0
- 2.27.0
- 2.26.0
- 2.25.1
- 2.24.0
- 2.23.1
- 2.22.1
- 2.21.1
- 2.15.0
- 2.14.3
- 2.13.0
- 2.12.0
- 2.11.0
- 2.10.0
- 2.9.6
- 2.8.4
- 2.7.4
public
final
class
Service
extends
GeneratedMessageV3
implements
ServiceOrBuilder
Service
is the root object of Google service configuration schema. It
describes basic information about a service, such as the name and the
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. See each proto message definition for details.
Example:
type: google.api.Service
name: calendar.googleapis.com
title: Google Calendar API
apis:
- name: google.calendar.v3.Calendar
authentication:
providers:
- id: google_calendar_auth jwks_uri: https://www.googleapis.com/oauth2/v1/certs issuer: https://securetoken.google.com rules:
- selector: "*" requirements: provider_id: google_calendar_auth
Protobuf type google.api.Service
Inheritance
Object > AbstractMessageLite<MessageType,BuilderType> > AbstractMessage > GeneratedMessageV3 > ServiceImplements
ServiceOrBuilderStatic Fields
APIS_FIELD_NUMBER
public
static
final
int
APIS_FIELD_NUMBER
| Type | Description |
|---|---|
| int |
AUTHENTICATION_FIELD_NUMBER
public
static
final
int
AUTHENTICATION_FIELD_NUMBER
| Type | Description |
|---|---|
| int |
BACKEND_FIELD_NUMBER
public
static
final
int
BACKEND_FIELD_NUMBER
| Type | Description |
|---|---|
| int |
BILLING_FIELD_NUMBER
public
static
final
int
BILLING_FIELD_NUMBER
| Type | Description |
|---|---|
| int |
CONFIG_VERSION_FIELD_NUMBER
public
static
final
int
CONFIG_VERSION_FIELD_NUMBER
| Type | Description |
|---|---|
| int |
CONTEXT_FIELD_NUMBER
public
static
final
int
CONTEXT_FIELD_NUMBER
| Type | Description |
|---|---|
| int |
CONTROL_FIELD_NUMBER
public
static
final
int
CONTROL_FIELD_NUMBER
| Type | Description |
|---|---|
| int |
DOCUMENTATION_FIELD_NUMBER
public
static
final
int
DOCUMENTATION_FIELD_NUMBER
| Type | Description |
|---|---|
| int |
ENDPOINTS_FIELD_NUMBER
public
static
final
int
ENDPOINTS_FIELD_NUMBER
| Type | Description |
|---|---|
| int |
ENUMS_FIELD_NUMBER
public
static
final
int
ENUMS_FIELD_NUMBER
| Type | Description |
|---|---|
| int |
HTTP_FIELD_NUMBER
public
static
final
int
HTTP_FIELD_NUMBER
| Type | Description |
|---|---|
| int |
ID_FIELD_NUMBER
public
static
final
int
ID_FIELD_NUMBER
| Type | Description |
|---|---|
| int |
LOGGING_FIELD_NUMBER
public
static
final
int
LOGGING_FIELD_NUMBER
| Type | Description |
|---|---|
| int |
LOGS_FIELD_NUMBER
public
static
final
int
LOGS_FIELD_NUMBER
| Type | Description |
|---|---|
| int |
METRICS_FIELD_NUMBER
public
static
final
int
METRICS_FIELD_NUMBER
| Type | Description |
|---|---|
| int |
MONITORED_RESOURCES_FIELD_NUMBER
public
static
final
int
MONITORED_RESOURCES_FIELD_NUMBER
| Type | Description |
|---|---|
| int |
MONITORING_FIELD_NUMBER
public
static
final
int
MONITORING_FIELD_NUMBER
| Type | Description |
|---|---|
| int |
NAME_FIELD_NUMBER
public
static
final
int
NAME_FIELD_NUMBER
| Type | Description |
|---|---|
| int |
PRODUCER_PROJECT_ID_FIELD_NUMBER
public
static
final
int
PRODUCER_PROJECT_ID_FIELD_NUMBER
| Type | Description |
|---|---|
| int |
QUOTA_FIELD_NUMBER
public
static
final
int
QUOTA_FIELD_NUMBER
| Type | Description |
|---|---|
| int |
SOURCE_INFO_FIELD_NUMBER
public
static
final
int
SOURCE_INFO_FIELD_NUMBER
| Type | Description |
|---|---|
| int |
SYSTEM_PARAMETERS_FIELD_NUMBER
public
static
final
int
SYSTEM_PARAMETERS_FIELD_NUMBER
| Type | Description |
|---|---|
| int |
TITLE_FIELD_NUMBER
public
static
final
int
TITLE_FIELD_NUMBER
| Type | Description |
|---|---|
| int |
TYPES_FIELD_NUMBER
public
static
final
int
TYPES_FIELD_NUMBER
| Type | Description |
|---|---|
| int |
USAGE_FIELD_NUMBER
public
static
final
int
USAGE_FIELD_NUMBER
| Type | Description |
|---|---|
| int |
Static Methods
getDefaultInstance()
public
static
Service
getDefaultInstance
()
| Type | Description |
|---|---|
| Service |
getDescriptor()
public
static
final
Descriptors
.
Descriptor
getDescriptor
()
| Type | Description |
|---|---|
| Descriptor |
newBuilder()
public
static
Service
.
Builder
newBuilder
()
| Type | Description |
|---|---|
| Service.Builder |
newBuilder(Service prototype)
public
static
Service
.
Builder
newBuilder
(
Service
prototype
)
| Name | Description |
|---|---|
| prototype | Service
|
| Type | Description |
|---|---|
| Service.Builder |
parseDelimitedFrom(InputStream input)
public
static
Service
parseDelimitedFrom
(
InputStream
input
)
| Name | Description |
|---|---|
| input | InputStream
|
| Type | Description |
|---|---|
| Service |
| Type | Description |
|---|---|
| IOException |
parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
public
static
Service
parseDelimitedFrom
(
InputStream
input
,
ExtensionRegistryLite
extensionRegistry
)
| Name | Description |
| input | InputStream
|
| extensionRegistry | ExtensionRegistryLite
|
| Type | Description |
|---|---|
| Service |
| Type | Description |
|---|---|
| IOException |
parseFrom(byte[] data)
public
static
Service
parseFrom
(
byte
[]
data
)
| Name | Description |
|---|---|
| data | byte
[]
|
| Type | Description |
|---|---|
| Service |
| Type | Description |
|---|---|
| InvalidProtocolBufferException |
parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
public
static
Service
parseFrom
(
byte
[]
data
,
ExtensionRegistryLite
extensionRegistry
)
| Name | Description |
| data | byte
[]
|
| extensionRegistry | ExtensionRegistryLite
|
| Type | Description |
|---|---|
| Service |
| Type | Description |
|---|---|
| InvalidProtocolBufferException |
parseFrom(ByteString data)
public
static
Service
parseFrom
(
ByteString
data
)
| Name | Description |
|---|---|
| data | ByteString
|
| Type | Description |
|---|---|
| Service |
| Type | Description |
|---|---|
| InvalidProtocolBufferException |
parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public
static
Service
parseFrom
(
ByteString
data
,
ExtensionRegistryLite
extensionRegistry
)
| Name | Description |
| data | ByteString
|
| extensionRegistry | ExtensionRegistryLite
|
| Type | Description |
|---|---|
| Service |
| Type | Description |
|---|---|
| InvalidProtocolBufferException |
parseFrom(CodedInputStream input)
public
static
Service
parseFrom
(
CodedInputStream
input
)
| Name | Description |
|---|---|
| input | CodedInputStream
|
| Type | Description |
|---|---|
| Service |
| Type | Description |
|---|---|
| IOException |
parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
public
static
Service
parseFrom
(
CodedInputStream
input
,
ExtensionRegistryLite
extensionRegistry
)
| Name | Description |
| input | CodedInputStream
|
| extensionRegistry | ExtensionRegistryLite
|
| Type | Description |
|---|---|
| Service |
| Type | Description |
|---|---|
| IOException |
parseFrom(InputStream input)
public
static
Service
parseFrom
(
InputStream
input
)
| Name | Description |
|---|---|
| input | InputStream
|
| Type | Description |
|---|---|
| Service |
| Type | Description |
|---|---|
| IOException |
parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
public
static
Service
parseFrom
(
InputStream
input
,
ExtensionRegistryLite
extensionRegistry
)
| Name | Description |
| input | InputStream
|
| extensionRegistry | ExtensionRegistryLite
|
| Type | Description |
|---|---|
| Service |
| Type | Description |
|---|---|
| IOException |
parseFrom(ByteBuffer data)
public
static
Service
parseFrom
(
ByteBuffer
data
)
| Name | Description |
|---|---|
| data | ByteBuffer
|
| Type | Description |
|---|---|
| Service |
| Type | Description |
|---|---|
| InvalidProtocolBufferException |
parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
public
static
Service
parseFrom
(
ByteBuffer
data
,
ExtensionRegistryLite
extensionRegistry
)
| Name | Description |
| data | ByteBuffer
|
| extensionRegistry | ExtensionRegistryLite
|
| Type | Description |
|---|---|
| Service |
| Type | Description |
|---|---|
| InvalidProtocolBufferException |
parser()
public
static
Parser<Service>
parser
()
| Type | Description |
|---|---|
| Parser < Service > |
Methods
equals(Object obj)
public
boolean
equals
(
Object
obj
)
| Name | Description |
|---|---|
| obj | Object
|
| Type | Description |
|---|---|
| boolean |
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;
| Name | Description |
|---|---|
| index | int
|
| 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;
| 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;
| Type | Description |
|---|---|
| List < Api > |
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;
| Name | Description |
|---|---|
| index | int
|
| Type | Description |
|---|---|
| ApiOrBuilder |
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;
| Type | Description |
|---|---|
| List < ? extends com.google.protobuf.ApiOrBuilder > |
getAuthentication()
public
Authentication
getAuthentication
()
Auth configuration.
.google.api.Authentication authentication = 11;
| Type | Description |
|---|---|
| Authentication | The authentication. |
getAuthenticationOrBuilder()
public
AuthenticationOrBuilder
getAuthenticationOrBuilder
()
Auth configuration.
.google.api.Authentication authentication = 11;
| Type | Description |
|---|---|
| AuthenticationOrBuilder |
getBackend()
public
Backend
getBackend
()
API backend configuration.
.google.api.Backend backend = 8;
| Type | Description |
|---|---|
| Backend | The backend. |
getBackendOrBuilder()
public
BackendOrBuilder
getBackendOrBuilder
()
API backend configuration.
.google.api.Backend backend = 8;
| Type | Description |
|---|---|
| BackendOrBuilder |
getBilling()
public
Billing
getBilling
()
Billing configuration.
.google.api.Billing billing = 26;
| Type | Description |
|---|---|
| Billing | The billing. |
getBillingOrBuilder()
public
BillingOrBuilder
getBillingOrBuilder
()
Billing configuration.
.google.api.Billing billing = 26;
| Type | Description |
|---|---|
| BillingOrBuilder |
getConfigVersion() (deprecated)
public
UInt32Value
getConfigVersion
()
Deprecated. google.api.Service.config_version is deprecated. See google/api/service.proto;l=170
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 [deprecated = true];
| 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 [deprecated = true];
| Type | Description |
|---|---|
| UInt32ValueOrBuilder |
getContext()
public
Context
getContext
()
Context configuration.
.google.api.Context context = 12;
| Type | Description |
|---|---|
| Context | The context. |
getContextOrBuilder()
public
ContextOrBuilder
getContextOrBuilder
()
Context configuration.
.google.api.Context context = 12;
| Type | Description |
|---|---|
| ContextOrBuilder |
getControl()
public
Control
getControl
()
Configuration for the service control plane.
.google.api.Control control = 21;
| Type | Description |
|---|---|
| Control | The control. |
getControlOrBuilder()
public
ControlOrBuilder
getControlOrBuilder
()
Configuration for the service control plane.
.google.api.Control control = 21;
| Type | Description |
|---|---|
| ControlOrBuilder |
getDefaultInstanceForType()
public
Service
getDefaultInstanceForType
()
| Type | Description |
|---|---|
| Service |
getDocumentation()
public
Documentation
getDocumentation
()
Additional API documentation.
.google.api.Documentation documentation = 6;
| Type | Description |
|---|---|
| Documentation | The documentation. |
getDocumentationOrBuilder()
public
DocumentationOrBuilder
getDocumentationOrBuilder
()
Additional API documentation.
.google.api.Documentation documentation = 6;
| Type | Description |
|---|---|
| DocumentationOrBuilder |
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;
| Name | Description |
|---|---|
| index | int
|
| Type | Description |
|---|---|
| Endpoint |
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;
| 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;
| Type | Description |
|---|---|
| List < Endpoint > |
getEndpointsOrBuilder(int index)
public
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;
| Name | Description |
|---|---|
| index | int
|
| Type | Description |
|---|---|
| EndpointOrBuilder |
getEndpointsOrBuilderList()
public
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;
| Type | Description |
|---|---|
| List < ? extends com.google.api.EndpointOrBuilder > |
getEnums(int index)
public
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;
| Name | Description |
|---|---|
| index | int
|
| Type | Description |
|---|---|
| Enum |
getEnumsCount()
public
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;
| Type | Description |
|---|---|
| int |
getEnumsList()
public
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;
| Type | Description |
|---|---|
| List < Enum > |
getEnumsOrBuilder(int index)
public
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;
| Name | Description |
|---|---|
| index | int
|
| Type | Description |
|---|---|
| EnumOrBuilder |
getEnumsOrBuilderList()
public
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;
| Type | Description |
|---|---|
| List < ? extends com.google.protobuf.EnumOrBuilder > |
getHttp()
public
Http
getHttp
()
HTTP configuration.
.google.api.Http http = 9;
| Type | Description |
|---|---|
| Http | The http. |
getHttpOrBuilder()
public
HttpOrBuilder
getHttpOrBuilder
()
HTTP configuration.
.google.api.Http http = 9;
| Type | Description |
|---|---|
| HttpOrBuilder |
getId()
public
String
getId
()
A unique ID for a specific instance of this message, typically assigned by the client for tracking purpose. Must be no longer than 63 characters and only lower case letters, digits, '.', '_' and '-' are allowed. If empty, the server may choose to generate one instead.
string id = 33;
| Type | Description |
|---|---|
| String | The id. |
getIdBytes()
public
ByteString
getIdBytes
()
A unique ID for a specific instance of this message, typically assigned by the client for tracking purpose. Must be no longer than 63 characters and only lower case letters, digits, '.', '_' and '-' are allowed. If empty, the server may choose to generate one instead.
string id = 33;
| Type | Description |
|---|---|
| ByteString | The bytes for id. |
getLogging()
public
Logging
getLogging
()
Logging configuration.
.google.api.Logging logging = 27;
| Type | Description |
|---|---|
| Logging | The logging. |
getLoggingOrBuilder()
public
LoggingOrBuilder
getLoggingOrBuilder
()
Logging configuration.
.google.api.Logging logging = 27;
| Type | Description |
|---|---|
| LoggingOrBuilder |
getLogs(int index)
public
LogDescriptor
getLogs
(
int
index
)
Defines the logs used by this service.
repeated .google.api.LogDescriptor logs = 23;
| Name | Description |
|---|---|
| index | int
|
| Type | Description |
|---|---|
| LogDescriptor |
getLogsCount()
public
int
getLogsCount
()
Defines the logs used by this service.
repeated .google.api.LogDescriptor logs = 23;
| Type | Description |
|---|---|
| int |
getLogsList()
public
List<LogDescriptor>
getLogsList
()
Defines the logs used by this service.
repeated .google.api.LogDescriptor logs = 23;
| Type | Description |
|---|---|
| List < LogDescriptor > |
getLogsOrBuilder(int index)
public
LogDescriptorOrBuilder
getLogsOrBuilder
(
int
index
)
Defines the logs used by this service.
repeated .google.api.LogDescriptor logs = 23;
| Name | Description |
|---|---|
| index | int
|
| Type | Description |
|---|---|
| LogDescriptorOrBuilder |
getLogsOrBuilderList()
public
List
< ?
extends
LogDescriptorOrBuilder
>
getLogsOrBuilderList
()
Defines the logs used by this service.
repeated .google.api.LogDescriptor logs = 23;
| Type | Description |
|---|---|
| List < ? extends com.google.api.LogDescriptorOrBuilder > |
getMetrics(int index)
public
MetricDescriptor
getMetrics
(
int
index
)
Defines the metrics used by this service.
repeated .google.api.MetricDescriptor metrics = 24;
| Name | Description |
|---|---|
| index | int
|
| Type | Description |
|---|---|
| MetricDescriptor |
getMetricsCount()
public
int
getMetricsCount
()
Defines the metrics used by this service.
repeated .google.api.MetricDescriptor metrics = 24;
| Type | Description |
|---|---|
| int |
getMetricsList()
public
List<MetricDescriptor>
getMetricsList
()
Defines the metrics used by this service.
repeated .google.api.MetricDescriptor metrics = 24;
| Type | Description |
|---|---|
| List < MetricDescriptor > |
getMetricsOrBuilder(int index)
public
MetricDescriptorOrBuilder
getMetricsOrBuilder
(
int
index
)
Defines the metrics used by this service.
repeated .google.api.MetricDescriptor metrics = 24;
| Name | Description |
|---|---|
| index | int
|
| Type | Description |
|---|---|
| MetricDescriptorOrBuilder |
getMetricsOrBuilderList()
public
List
< ?
extends
MetricDescriptorOrBuilder
>
getMetricsOrBuilderList
()
Defines the metrics used by this service.
repeated .google.api.MetricDescriptor metrics = 24;
| Type | Description |
|---|---|
| List < ? extends com.google.api.MetricDescriptorOrBuilder > |
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;
| Name | Description |
|---|---|
| index | int
|
| Type | Description |
|---|---|
| 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;
| 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;
| Type | Description |
|---|---|
| List < 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;
| Name | Description |
|---|---|
| index | int
|
| Type | Description |
|---|---|
| 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;
| Type | Description |
|---|---|
| List < ? extends com.google.api.MonitoredResourceDescriptorOrBuilder > |
getMonitoring()
public
Monitoring
getMonitoring
()
Monitoring configuration.
.google.api.Monitoring monitoring = 28;
| Type | Description |
|---|---|
| Monitoring | The monitoring. |
getMonitoringOrBuilder()
public
MonitoringOrBuilder
getMonitoringOrBuilder
()
Monitoring configuration.
.google.api.Monitoring monitoring = 28;
| Type | Description |
|---|---|
| MonitoringOrBuilder |
getName()
public
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;
| Type | Description |
|---|---|
| String | The name. |
getNameBytes()
public
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;
| Type | Description |
|---|---|
| ByteString | The bytes for name. |
getParserForType()
public
Parser<Service>
getParserForType
()
| Type | Description |
|---|---|
| Parser < Service > |
getProducerProjectId()
public
String
getProducerProjectId
()
The Google project that owns this service.
string producer_project_id = 22;
| Type | Description |
|---|---|
| String | The producerProjectId. |
getProducerProjectIdBytes()
public
ByteString
getProducerProjectIdBytes
()
The Google project that owns this service.
string producer_project_id = 22;
| Type | Description |
| ByteString | The bytes for producerProjectId. |
getQuota()
public
Quota
getQuota
()
Quota configuration.
.google.api.Quota quota = 10;
| Type | Description |
|---|---|
| Quota | The quota. |
getQuotaOrBuilder()
public
QuotaOrBuilder
getQuotaOrBuilder
()
Quota configuration.
.google.api.Quota quota = 10;
| Type | Description |
|---|---|
| QuotaOrBuilder |
getSerializedSize()
public
int
getSerializedSize
()
| Type | Description |
|---|---|
| int |
getSourceInfo()
public
SourceInfo
getSourceInfo
()
Output only. The source information for this configuration if available.
.google.api.SourceInfo source_info = 37;
| Type | Description |
|---|---|
| SourceInfo | The sourceInfo. |
getSourceInfoOrBuilder()
public
SourceInfoOrBuilder
getSourceInfoOrBuilder
()
Output only. The source information for this configuration if available.
.google.api.SourceInfo source_info = 37;
| Type | Description |
|---|---|
| SourceInfoOrBuilder |
getSystemParameters()
public
SystemParameters
getSystemParameters
()
System parameter configuration.
.google.api.SystemParameters system_parameters = 29;
| Type | Description |
|---|---|
| SystemParameters | The systemParameters. |
getSystemParametersOrBuilder()
public
SystemParametersOrBuilder
getSystemParametersOrBuilder
()
System parameter configuration.
.google.api.SystemParameters system_parameters = 29;
| Type | Description |
|---|---|
| SystemParametersOrBuilder |
getTitle()
public
String
getTitle
()
The product title for this service.
string title = 2;
| Type | Description |
|---|---|
| String | The title. |
getTitleBytes()
public
ByteString
getTitleBytes
()
The product title for this service.
string title = 2;
| Type | Description |
|---|---|
| ByteString | The bytes for title. |
getTypes(int index)
public
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;
| Name | Description |
|---|---|
| index | int
|
| Type | Description |
|---|---|
| Type |
getTypesCount()
public
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;
| Type | Description |
|---|---|
| int |
getTypesList()
public
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;
| Type | Description |
|---|---|
| List < Type > |
getTypesOrBuilder(int index)
public
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;
| Name | Description |
|---|---|
| index | int
|
| Type | Description |
|---|---|
| TypeOrBuilder |
getTypesOrBuilderList()
public
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;
| Type | Description |
|---|---|
| List < ? extends com.google.protobuf.TypeOrBuilder > |
getUnknownFields()
public
final
UnknownFieldSet
getUnknownFields
()
| Type | Description |
|---|---|
| UnknownFieldSet |
getUsage()
public
Usage
getUsage
()
Configuration controlling usage of this service.
.google.api.Usage usage = 15;
| Type | Description |
|---|---|
| Usage | The usage. |
getUsageOrBuilder()
public
UsageOrBuilder
getUsageOrBuilder
()
Configuration controlling usage of this service.
.google.api.Usage usage = 15;
| Type | Description |
|---|---|
| UsageOrBuilder |
hasAuthentication()
public
boolean
hasAuthentication
()
Auth configuration.
.google.api.Authentication authentication = 11;
| Type | Description |
| boolean | Whether the authentication field is set. |
hasBackend()
public
boolean
hasBackend
()
API backend configuration.
.google.api.Backend backend = 8;
| Type | Description |
| boolean | Whether the backend field is set. |
hasBilling()
public
boolean
hasBilling
()
Billing configuration.
.google.api.Billing billing = 26;
| Type | Description |
| boolean | Whether the billing field is set. |
hasConfigVersion() (deprecated)
public
boolean
hasConfigVersion
()
Deprecated. google.api.Service.config_version is deprecated. See google/api/service.proto;l=170
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 [deprecated = true];
| Type | Description |
| boolean | Whether the configVersion field is set. |
hasContext()
public
boolean
hasContext
()
Context configuration.
.google.api.Context context = 12;
| Type | Description |
| boolean | Whether the context field is set. |
hasControl()
public
boolean
hasControl
()
Configuration for the service control plane.
.google.api.Control control = 21;
| Type | Description |
| boolean | Whether the control field is set. |
hasDocumentation()
public
boolean
hasDocumentation
()
Additional API documentation.
.google.api.Documentation documentation = 6;
| Type | Description |
| boolean | Whether the documentation field is set. |
hasHttp()
public
boolean
hasHttp
()
HTTP configuration.
.google.api.Http http = 9;
| Type | Description |
| boolean | Whether the http field is set. |
hasLogging()
public
boolean
hasLogging
()
Logging configuration.
.google.api.Logging logging = 27;
| Type | Description |
| boolean | Whether the logging field is set. |
hasMonitoring()
public
boolean
hasMonitoring
()
Monitoring configuration.
.google.api.Monitoring monitoring = 28;
| Type | Description |
| boolean | Whether the monitoring field is set. |
hasQuota()
public
boolean
hasQuota
()
Quota configuration.
.google.api.Quota quota = 10;
| Type | Description |
| boolean | Whether the quota field is set. |
hasSourceInfo()
public
boolean
hasSourceInfo
()
Output only. The source information for this configuration if available.
.google.api.SourceInfo source_info = 37;
| Type | Description |
| boolean | Whether the sourceInfo field is set. |
hasSystemParameters()
public
boolean
hasSystemParameters
()
System parameter configuration.
.google.api.SystemParameters system_parameters = 29;
| Type | Description |
| boolean | Whether the systemParameters field is set. |
hasUsage()
public
boolean
hasUsage
()
Configuration controlling usage of this service.
.google.api.Usage usage = 15;
| Type | Description |
| boolean | Whether the usage field is set. |
hashCode()
public
int
hashCode
()
| Type | Description |
|---|---|
| int |
internalGetFieldAccessorTable()
protected
GeneratedMessageV3
.
FieldAccessorTable
internalGetFieldAccessorTable
()
| Type | Description |
|---|---|
| FieldAccessorTable |
isInitialized()
public
final
boolean
isInitialized
()
| Type | Description |
|---|---|
| boolean |
newBuilderForType()
public
Service
.
Builder
newBuilderForType
()
| Type | Description |
|---|---|
| Service.Builder |
newBuilderForType(GeneratedMessageV3.BuilderParent parent)
protected
Service
.
Builder
newBuilderForType
(
GeneratedMessageV3
.
BuilderParent
parent
)
| Name | Description |
|---|---|
| parent | BuilderParent
|
| Type | Description |
|---|---|
| Service.Builder |
newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
protected
Object
newInstance
(
GeneratedMessageV3
.
UnusedPrivateParameter
unused
)
| Name | Description |
| unused | UnusedPrivateParameter
|
| Type | Description |
|---|---|
| Object |
toBuilder()
public
Service
.
Builder
toBuilder
()
| Type | Description |
|---|---|
| Service.Builder |
writeTo(CodedOutputStream output)
public
void
writeTo
(
CodedOutputStream
output
)
| Name | Description |
|---|---|
| output | CodedOutputStream
|
| Type | Description |
|---|---|
| IOException |
