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:
- selector: "google.calendar.v3.*"
restriction: PREVIEW
backend:
rules:
- selector: "google.calendar.v3.*"
address: calendar.example.com
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| 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()| Returns | |
|---|---|
| Type | Description |
Service |
|
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()| Returns | |
|---|---|
| Type | Description |
Descriptor |
|
newBuilder()
public static Service.Builder newBuilder()| Returns | |
|---|---|
| Type | Description |
Service.Builder |
|
newBuilder(Service prototype)
public static Service.Builder newBuilder(Service prototype)| Parameter | |
|---|---|
| Name | Description |
prototype |
Service |
| Returns | |
|---|---|
| Type | Description |
Service.Builder |
|
parseDelimitedFrom(InputStream input)
public static Service parseDelimitedFrom(InputStream input)| Parameter | |
|---|---|
| Name | Description |
input |
InputStream |
| Returns | |
|---|---|
| Type | Description |
Service |
|
| Exceptions | |
|---|---|
| Type | Description |
IOException |
|
parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
public static Service parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)| Parameters | |
|---|---|
| Name | Description |
input |
InputStream |
extensionRegistry |
ExtensionRegistryLite |
| Returns | |
|---|---|
| Type | Description |
Service |
|
| Exceptions | |
|---|---|
| Type | Description |
IOException |
|
parseFrom(byte[] data)
public static Service parseFrom(byte[] data)| Parameter | |
|---|---|
| Name | Description |
data |
byte[] |
| Returns | |
|---|---|
| Type | Description |
Service |
|
| Exceptions | |
|---|---|
| Type | Description |
InvalidProtocolBufferException |
|
parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
public static Service parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)| Parameters | |
|---|---|
| Name | Description |
data |
byte[] |
extensionRegistry |
ExtensionRegistryLite |
| Returns | |
|---|---|
| Type | Description |
Service |
|
| Exceptions | |
|---|---|
| Type | Description |
InvalidProtocolBufferException |
|
parseFrom(ByteString data)
public static Service parseFrom(ByteString data)| Parameter | |
|---|---|
| Name | Description |
data |
ByteString |
| Returns | |
|---|---|
| Type | Description |
Service |
|
| Exceptions | |
|---|---|
| Type | Description |
InvalidProtocolBufferException |
|
parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static Service parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)| Parameters | |
|---|---|
| Name | Description |
data |
ByteString |
extensionRegistry |
ExtensionRegistryLite |
| Returns | |
|---|---|
| Type | Description |
Service |
|
| Exceptions | |
|---|---|
| Type | Description |
InvalidProtocolBufferException |
|
parseFrom(CodedInputStream input)
public static Service parseFrom(CodedInputStream input)| Parameter | |
|---|---|
| Name | Description |
input |
CodedInputStream |
| Returns | |
|---|---|
| Type | Description |
Service |
|
| Exceptions | |
|---|---|
| Type | Description |
IOException |
|
parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
public static Service parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)| Parameters | |
|---|---|
| Name | Description |
input |
CodedInputStream |
extensionRegistry |
ExtensionRegistryLite |
| Returns | |
|---|---|
| Type | Description |
Service |
|
| Exceptions | |
|---|---|
| Type | Description |
IOException |
|
parseFrom(InputStream input)
public static Service parseFrom(InputStream input)| Parameter | |
|---|---|
| Name | Description |
input |
InputStream |
| Returns | |
|---|---|
| Type | Description |
Service |
|
| Exceptions | |
|---|---|
| Type | Description |
IOException |
|
parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
public static Service parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)| Parameters | |
|---|---|
| Name | Description |
input |
InputStream |
extensionRegistry |
ExtensionRegistryLite |
| Returns | |
|---|---|
| Type | Description |
Service |
|
| Exceptions | |
|---|---|
| Type | Description |
IOException |
|
parseFrom(ByteBuffer data)
public static Service parseFrom(ByteBuffer data)| Parameter | |
|---|---|
| Name | Description |
data |
ByteBuffer |
| Returns | |
|---|---|
| Type | Description |
Service |
|
| Exceptions | |
|---|---|
| Type | Description |
InvalidProtocolBufferException |
|
parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
public static Service parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)| Parameters | |
|---|---|
| Name | Description |
data |
ByteBuffer |
extensionRegistry |
ExtensionRegistryLite |
| Returns | |
|---|---|
| Type | Description |
Service |
|
| Exceptions | |
|---|---|
| Type | Description |
InvalidProtocolBufferException |
|
parser()
public static Parser<Service> parser()| Returns | |
|---|---|
| Type | Description |
Parser<Service> |
|
Methods
equals(Object obj)
public boolean equals(Object obj)| Parameter | |
|---|---|
| Name | Description |
obj |
Object |
| Returns | |
|---|---|
| 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;
| 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;
| Returns | |
|---|---|
| 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;
| Parameter | |
|---|---|
| Name | Description |
index |
int |
| Returns | |
|---|---|
| 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;
| Returns | |
|---|---|
| Type | Description |
List<? extends com.google.protobuf.ApiOrBuilder> |
|
getAuthentication()
public Authentication getAuthentication()Auth configuration.
.google.api.Authentication authentication = 11;
| Returns | |
|---|---|
| Type | Description |
Authentication |
The authentication. |
getAuthenticationOrBuilder()
public AuthenticationOrBuilder getAuthenticationOrBuilder()Auth configuration.
.google.api.Authentication authentication = 11;
| Returns | |
|---|---|
| Type | Description |
AuthenticationOrBuilder |
|
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;
| Returns | |
|---|---|
| Type | Description |
BackendOrBuilder |
|
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;
| Returns | |
|---|---|
| Type | Description |
BillingOrBuilder |
|
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;
| Returns | |
|---|---|
| Type | Description |
UInt32ValueOrBuilder |
|
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;
| Returns | |
|---|---|
| Type | Description |
ContextOrBuilder |
|
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;
| Returns | |
|---|---|
| Type | Description |
ControlOrBuilder |
|
getDefaultInstanceForType()
public Service getDefaultInstanceForType()| Returns | |
|---|---|
| Type | Description |
Service |
|
getDocumentation()
public Documentation getDocumentation()Additional API documentation.
.google.api.Documentation documentation = 6;
| Returns | |
|---|---|
| Type | Description |
Documentation |
The documentation. |
getDocumentationOrBuilder()
public DocumentationOrBuilder getDocumentationOrBuilder()Additional API documentation.
.google.api.Documentation documentation = 6;
| Returns | |
|---|---|
| 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;
| Parameter | |
|---|---|
| Name | Description |
index |
int |
| Returns | |
|---|---|
| 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;
| 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;
| Returns | |
|---|---|
| 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;
| Parameter | |
|---|---|
| Name | Description |
index |
int |
| Returns | |
|---|---|
| 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;
| Returns | |
|---|---|
| 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 by the configuration author. Example:
enums:
- name: google.someapi.v1.SomeEnum
repeated .google.protobuf.Enum enums = 5;
| Parameter | |
|---|---|
| Name | Description |
index |
int |
| Returns | |
|---|---|
| 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 by the configuration author. Example:
enums:
- name: google.someapi.v1.SomeEnum
repeated .google.protobuf.Enum enums = 5;
| Returns | |
|---|---|
| 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 by the configuration author. Example:
enums:
- name: google.someapi.v1.SomeEnum
repeated .google.protobuf.Enum enums = 5;
| Returns | |
|---|---|
| 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 by the configuration author. Example:
enums:
- name: google.someapi.v1.SomeEnum
repeated .google.protobuf.Enum enums = 5;
| Parameter | |
|---|---|
| Name | Description |
index |
int |
| Returns | |
|---|---|
| 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 by the configuration author. Example:
enums:
- name: google.someapi.v1.SomeEnum
repeated .google.protobuf.Enum enums = 5;
| Returns | |
|---|---|
| Type | Description |
List<? extends com.google.protobuf.EnumOrBuilder> |
|
getHttp()
public Http getHttp()HTTP configuration.
.google.api.Http http = 9;
| Returns | |
|---|---|
| Type | Description |
Http |
The http. |
getHttpOrBuilder()
public HttpOrBuilder getHttpOrBuilder()HTTP configuration.
.google.api.Http http = 9;
| Returns | |
|---|---|
| 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;
| Returns | |
|---|---|
| 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;
| Returns | |
|---|---|
| Type | Description |
ByteString |
The bytes for id. |
getLogging()
public Logging getLogging()Logging configuration.
.google.api.Logging logging = 27;
| Returns | |
|---|---|
| Type | Description |
Logging |
The logging. |
getLoggingOrBuilder()
public LoggingOrBuilder getLoggingOrBuilder()Logging configuration.
.google.api.Logging logging = 27;
| Returns | |
|---|---|
| Type | Description |
LoggingOrBuilder |
|
getLogs(int index)
public LogDescriptor getLogs(int index)Defines the logs used by this service.
repeated .google.api.LogDescriptor logs = 23;
| Parameter | |
|---|---|
| Name | Description |
index |
int |
| Returns | |
|---|---|
| Type | Description |
LogDescriptor |
|
getLogsCount()
public int getLogsCount()Defines the logs used by this service.
repeated .google.api.LogDescriptor logs = 23;
| Returns | |
|---|---|
| Type | Description |
int |
|
getLogsList()
public List<LogDescriptor> getLogsList()Defines the logs used by this service.
repeated .google.api.LogDescriptor logs = 23;
| Returns | |
|---|---|
| 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;
| Parameter | |
|---|---|
| Name | Description |
index |
int |
| Returns | |
|---|---|
| Type | Description |
LogDescriptorOrBuilder |
|
getLogsOrBuilderList()
public List<? extends LogDescriptorOrBuilder> getLogsOrBuilderList()Defines the logs used by this service.
repeated .google.api.LogDescriptor logs = 23;
| Returns | |
|---|---|
| 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;
| Parameter | |
|---|---|
| Name | Description |
index |
int |
| Returns | |
|---|---|
| Type | Description |
MetricDescriptor |
|
getMetricsCount()
public int getMetricsCount()Defines the metrics used by this service.
repeated .google.api.MetricDescriptor metrics = 24;
| Returns | |
|---|---|
| Type | Description |
int |
|
getMetricsList()
public List<MetricDescriptor> getMetricsList()Defines the metrics used by this service.
repeated .google.api.MetricDescriptor metrics = 24;
| Returns | |
|---|---|
| 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;
| Parameter | |
|---|---|
| Name | Description |
index |
int |
| Returns | |
|---|---|
| Type | Description |
MetricDescriptorOrBuilder |
|
getMetricsOrBuilderList()
public List<? extends MetricDescriptorOrBuilder> getMetricsOrBuilderList()Defines the metrics used by this service.
repeated .google.api.MetricDescriptor metrics = 24;
| Returns | |
|---|---|
| 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;
| Parameter | |
|---|---|
| Name | Description |
index |
int |
| Returns | |
|---|---|
| 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;
| 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<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 |
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.
.google.api.Monitoring monitoring = 28;
| Returns | |
|---|---|
| Type | Description |
Monitoring |
The monitoring. |
getMonitoringOrBuilder()
public MonitoringOrBuilder getMonitoringOrBuilder()Monitoring configuration.
.google.api.Monitoring monitoring = 28;
| Returns | |
|---|---|
| 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;
| Returns | |
|---|---|
| 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;
| Returns | |
|---|---|
| Type | Description |
ByteString |
The bytes for name. |
getParserForType()
public Parser<Service> getParserForType()| Returns | |
|---|---|
| Type | Description |
Parser<Service> |
|
getProducerProjectId()
public String getProducerProjectId()The Google project that owns this service.
string producer_project_id = 22;
| Returns | |
|---|---|
| Type | Description |
String |
The producerProjectId. |
getProducerProjectIdBytes()
public ByteString getProducerProjectIdBytes()The Google project that owns this service.
string producer_project_id = 22;
| Returns | |
|---|---|
| Type | Description |
ByteString |
The bytes for producerProjectId. |
getPublishing()
public Publishing getPublishing()Settings for Google Cloud Client libraries generated from APIs defined as protocol buffers.
.google.api.Publishing publishing = 45;
| Returns | |
|---|---|
| Type | Description |
Publishing |
The publishing. |
getPublishingOrBuilder()
public PublishingOrBuilder getPublishingOrBuilder()Settings for Google Cloud Client libraries generated from APIs defined as protocol buffers.
.google.api.Publishing publishing = 45;
| Returns | |
|---|---|
| Type | Description |
PublishingOrBuilder |
|
getQuota()
public Quota getQuota()Quota configuration.
.google.api.Quota quota = 10;
| Returns | |
|---|---|
| Type | Description |
Quota |
The quota. |
getQuotaOrBuilder()
public QuotaOrBuilder getQuotaOrBuilder()Quota configuration.
.google.api.Quota quota = 10;
| Returns | |
|---|---|
| Type | Description |
QuotaOrBuilder |
|
getSerializedSize()
public int getSerializedSize()| Returns | |
|---|---|
| Type | Description |
int |
|
getSourceInfo()
public SourceInfo getSourceInfo()Output only. The source information for this configuration if available.
.google.api.SourceInfo source_info = 37;
| Returns | |
|---|---|
| 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;
| Returns | |
|---|---|
| Type | Description |
SourceInfoOrBuilder |
|
getSystemParameters()
public SystemParameters getSystemParameters()System parameter configuration.
.google.api.SystemParameters system_parameters = 29;
| Returns | |
|---|---|
| Type | Description |
SystemParameters |
The systemParameters. |
getSystemParametersOrBuilder()
public SystemParametersOrBuilder getSystemParametersOrBuilder()System parameter configuration.
.google.api.SystemParameters system_parameters = 29;
| Returns | |
|---|---|
| Type | Description |
SystemParametersOrBuilder |
|
getTitle()
public String getTitle()The product title for this service, it is the name displayed in Google Cloud Console.
string title = 2;
| Returns | |
|---|---|
| Type | Description |
String |
The title. |
getTitleBytes()
public ByteString getTitleBytes()The product title for this service, it is the name displayed in Google Cloud Console.
string title = 2;
| Returns | |
|---|---|
| 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 by the configuration author. Example:
types:
- name: google.protobuf.Int32
repeated .google.protobuf.Type types = 4;
| Parameter | |
|---|---|
| Name | Description |
index |
int |
| Returns | |
|---|---|
| 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 by the configuration author. Example:
types:
- name: google.protobuf.Int32
repeated .google.protobuf.Type types = 4;
| Returns | |
|---|---|
| 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 by the configuration author. Example:
types:
- name: google.protobuf.Int32
repeated .google.protobuf.Type types = 4;
| Returns | |
|---|---|
| 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 by the configuration author. Example:
types:
- name: google.protobuf.Int32
repeated .google.protobuf.Type types = 4;
| Parameter | |
|---|---|
| Name | Description |
index |
int |
| Returns | |
|---|---|
| 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 by the configuration author. Example:
types:
- name: google.protobuf.Int32
repeated .google.protobuf.Type types = 4;
| Returns | |
|---|---|
| Type | Description |
List<? extends com.google.protobuf.TypeOrBuilder> |
|
getUsage()
public Usage getUsage()Configuration controlling usage of this service.
.google.api.Usage usage = 15;
| Returns | |
|---|---|
| Type | Description |
Usage |
The usage. |
getUsageOrBuilder()
public UsageOrBuilder getUsageOrBuilder()Configuration controlling usage of this service.
.google.api.Usage usage = 15;
| Returns | |
|---|---|
| Type | Description |
UsageOrBuilder |
|
hasAuthentication()
public boolean hasAuthentication()Auth configuration.
.google.api.Authentication authentication = 11;
| Returns | |
|---|---|
| Type | Description |
boolean |
Whether the authentication field is set. |
hasBackend()
public boolean hasBackend()API backend configuration.
.google.api.Backend backend = 8;
| Returns | |
|---|---|
| Type | Description |
boolean |
Whether the backend field is set. |
hasBilling()
public boolean hasBilling()Billing configuration.
.google.api.Billing billing = 26;
| Returns | |
|---|---|
| Type | Description |
boolean |
Whether the billing field is set. |
hasConfigVersion()
public boolean hasConfigVersion()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 |
boolean |
Whether the configVersion field is set. |
hasContext()
public boolean hasContext()Context configuration.
.google.api.Context context = 12;
| Returns | |
|---|---|
| Type | Description |
boolean |
Whether the context field is set. |
hasControl()
public boolean hasControl()Configuration for the service control plane.
.google.api.Control control = 21;
| Returns | |
|---|---|
| Type | Description |
boolean |
Whether the control field is set. |
hasDocumentation()
public boolean hasDocumentation()Additional API documentation.
.google.api.Documentation documentation = 6;
| Returns | |
|---|---|
| Type | Description |
boolean |
Whether the documentation field is set. |
hasHttp()
public boolean hasHttp()HTTP configuration.
.google.api.Http http = 9;
| Returns | |
|---|---|
| Type | Description |
boolean |
Whether the http field is set. |
hasLogging()
public boolean hasLogging()Logging configuration.
.google.api.Logging logging = 27;
| Returns | |
|---|---|
| Type | Description |
boolean |
Whether the logging field is set. |
hasMonitoring()
public boolean hasMonitoring()Monitoring configuration.
.google.api.Monitoring monitoring = 28;
| Returns | |
|---|---|
| Type | Description |
boolean |
Whether the monitoring field is set. |
hasPublishing()
public boolean hasPublishing()Settings for Google Cloud Client libraries generated from APIs defined as protocol buffers.
.google.api.Publishing publishing = 45;
| Returns | |
|---|---|
| Type | Description |
boolean |
Whether the publishing field is set. |
hasQuota()
public boolean hasQuota()Quota configuration.
.google.api.Quota quota = 10;
| Returns | |
|---|---|
| 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;
| Returns | |
|---|---|
| Type | Description |
boolean |
Whether the sourceInfo field is set. |
hasSystemParameters()
public boolean hasSystemParameters()System parameter configuration.
.google.api.SystemParameters system_parameters = 29;
| Returns | |
|---|---|
| Type | Description |
boolean |
Whether the systemParameters 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 |
|
internalGetFieldAccessorTable()
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()| Returns | |
|---|---|
| Type | Description |
FieldAccessorTable |
|
isInitialized()
public final boolean isInitialized()| Returns | |
|---|---|
| Type | Description |
boolean |
|
newBuilderForType()
public Service.Builder newBuilderForType()| Returns | |
|---|---|
| Type | Description |
Service.Builder |
|
newBuilderForType(GeneratedMessageV3.BuilderParent parent)
protected Service.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)| Parameter | |
|---|---|
| Name | Description |
parent |
BuilderParent |
| Returns | |
|---|---|
| Type | Description |
Service.Builder |
|
newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)| Parameter | |
|---|---|
| Name | Description |
unused |
UnusedPrivateParameter |
| Returns | |
|---|---|
| Type | Description |
Object |
|
toBuilder()
public Service.Builder toBuilder()| Returns | |
|---|---|
| Type | Description |
Service.Builder |
|
writeTo(CodedOutputStream output)
public void writeTo(CodedOutputStream output)| Parameter | |
|---|---|
| Name | Description |
output |
CodedOutputStream |
| Exceptions | |
|---|---|
| Type | Description |
IOException |
|