Class Service.Builder (2.46.0)

public static final class Service.Builder extends GeneratedMessageV3.Builder<Service.Builder> 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

Implements

ServiceOrBuilder

Static Methods

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
Type Description
Descriptor

Methods

addAllApis(Iterable<? extends Api> values)

public Service.Builder addAllApis(Iterable<? extends Api> values)

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
values Iterable<? extends com.google.protobuf.Api>
Returns
Type Description
Service.Builder

addAllEndpoints(Iterable<? extends Endpoint> values)

public Service.Builder addAllEndpoints(Iterable<? extends Endpoint> values)

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
values Iterable<? extends com.google.api.Endpoint>
Returns
Type Description
Service.Builder

addAllEnums(Iterable<? extends Enum> values)

public Service.Builder addAllEnums(Iterable<? extends Enum> values)

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
values Iterable<? extends com.google.protobuf.Enum>
Returns
Type Description
Service.Builder

addAllLogs(Iterable<? extends LogDescriptor> values)

public Service.Builder addAllLogs(Iterable<? extends LogDescriptor> values)

Defines the logs used by this service.

repeated .google.api.LogDescriptor logs = 23;

Parameter
Name Description
values Iterable<? extends com.google.api.LogDescriptor>
Returns
Type Description
Service.Builder

addAllMetrics(Iterable<? extends MetricDescriptor> values)

public Service.Builder addAllMetrics(Iterable<? extends MetricDescriptor> values)

Defines the metrics used by this service.

repeated .google.api.MetricDescriptor metrics = 24;

Parameter
Name Description
values Iterable<? extends com.google.api.MetricDescriptor>
Returns
Type Description
Service.Builder

addAllMonitoredResources(Iterable<? extends MonitoredResourceDescriptor> values)

public Service.Builder addAllMonitoredResources(Iterable<? extends MonitoredResourceDescriptor> values)

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
values Iterable<? extends com.google.api.MonitoredResourceDescriptor>
Returns
Type Description
Service.Builder

addAllTypes(Iterable<? extends Type> values)

public Service.Builder addAllTypes(Iterable<? extends Type> values)

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
values Iterable<? extends com.google.protobuf.Type>
Returns
Type Description
Service.Builder

addApis(Api value)

public Service.Builder addApis(Api value)

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
value Api
Returns
Type Description
Service.Builder

addApis(Api.Builder builderForValue)

public Service.Builder addApis(Api.Builder builderForValue)

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
builderForValue Builder
Returns
Type Description
Service.Builder

addApis(int index, Api value)

public Service.Builder addApis(int index, Api value)

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;

Parameters
Name Description
index int
value Api
Returns
Type Description
Service.Builder

addApis(int index, Api.Builder builderForValue)

public Service.Builder addApis(int index, Api.Builder builderForValue)

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;

Parameters
Name Description
index int
builderForValue Builder
Returns
Type Description
Service.Builder

addApisBuilder()

public Api.Builder addApisBuilder()

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
Builder

addApisBuilder(int index)

public Api.Builder addApisBuilder(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
Builder

addEndpoints(Endpoint value)

public Service.Builder addEndpoints(Endpoint value)

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
value Endpoint
Returns
Type Description
Service.Builder

addEndpoints(Endpoint.Builder builderForValue)

public Service.Builder addEndpoints(Endpoint.Builder builderForValue)

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
builderForValue Endpoint.Builder
Returns
Type Description
Service.Builder

addEndpoints(int index, Endpoint value)

public Service.Builder addEndpoints(int index, Endpoint value)

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;

Parameters
Name Description
index int
value Endpoint
Returns
Type Description
Service.Builder

addEndpoints(int index, Endpoint.Builder builderForValue)

public Service.Builder addEndpoints(int index, Endpoint.Builder builderForValue)

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;

Parameters
Name Description
index int
builderForValue Endpoint.Builder
Returns
Type Description
Service.Builder

addEndpointsBuilder()

public Endpoint.Builder addEndpointsBuilder()

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
Endpoint.Builder

addEndpointsBuilder(int index)

public Endpoint.Builder addEndpointsBuilder(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.Builder

addEnums(Enum value)

public Service.Builder addEnums(Enum value)

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
value Enum
Returns
Type Description
Service.Builder

addEnums(Enum.Builder builderForValue)

public Service.Builder addEnums(Enum.Builder builderForValue)

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
builderForValue Builder
Returns
Type Description
Service.Builder

addEnums(int index, Enum value)

public Service.Builder addEnums(int index, Enum value)

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;

Parameters
Name Description
index int
value Enum
Returns
Type Description
Service.Builder

addEnums(int index, Enum.Builder builderForValue)

public Service.Builder addEnums(int index, Enum.Builder builderForValue)

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;

Parameters
Name Description
index int
builderForValue Builder
Returns
Type Description
Service.Builder

addEnumsBuilder()

public Enum.Builder addEnumsBuilder()

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
Builder

addEnumsBuilder(int index)

public Enum.Builder addEnumsBuilder(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
Builder

addLogs(LogDescriptor value)

public Service.Builder addLogs(LogDescriptor value)

Defines the logs used by this service.

repeated .google.api.LogDescriptor logs = 23;

Parameter
Name Description
value LogDescriptor
Returns
Type Description
Service.Builder

addLogs(LogDescriptor.Builder builderForValue)

public Service.Builder addLogs(LogDescriptor.Builder builderForValue)

Defines the logs used by this service.

repeated .google.api.LogDescriptor logs = 23;

Parameter
Name Description
builderForValue LogDescriptor.Builder
Returns
Type Description
Service.Builder

addLogs(int index, LogDescriptor value)

public Service.Builder addLogs(int index, LogDescriptor value)

Defines the logs used by this service.

repeated .google.api.LogDescriptor logs = 23;

Parameters
Name Description
index int
value LogDescriptor
Returns
Type Description
Service.Builder

addLogs(int index, LogDescriptor.Builder builderForValue)

public Service.Builder addLogs(int index, LogDescriptor.Builder builderForValue)

Defines the logs used by this service.

repeated .google.api.LogDescriptor logs = 23;

Parameters
Name Description
index int
builderForValue LogDescriptor.Builder
Returns
Type Description
Service.Builder

addLogsBuilder()

public LogDescriptor.Builder addLogsBuilder()

Defines the logs used by this service.

repeated .google.api.LogDescriptor logs = 23;

Returns
Type Description
LogDescriptor.Builder

addLogsBuilder(int index)

public LogDescriptor.Builder addLogsBuilder(int index)

Defines the logs used by this service.

repeated .google.api.LogDescriptor logs = 23;

Parameter
Name Description
index int
Returns
Type Description
LogDescriptor.Builder

addMetrics(MetricDescriptor value)

public Service.Builder addMetrics(MetricDescriptor value)

Defines the metrics used by this service.

repeated .google.api.MetricDescriptor metrics = 24;

Parameter
Name Description
value MetricDescriptor
Returns
Type Description
Service.Builder

addMetrics(MetricDescriptor.Builder builderForValue)

public Service.Builder addMetrics(MetricDescriptor.Builder builderForValue)

Defines the metrics used by this service.

repeated .google.api.MetricDescriptor metrics = 24;

Parameter
Name Description
builderForValue MetricDescriptor.Builder
Returns
Type Description
Service.Builder

addMetrics(int index, MetricDescriptor value)

public Service.Builder addMetrics(int index, MetricDescriptor value)

Defines the metrics used by this service.

repeated .google.api.MetricDescriptor metrics = 24;

Parameters
Name Description
index int
value MetricDescriptor
Returns
Type Description
Service.Builder

addMetrics(int index, MetricDescriptor.Builder builderForValue)

public Service.Builder addMetrics(int index, MetricDescriptor.Builder builderForValue)

Defines the metrics used by this service.

repeated .google.api.MetricDescriptor metrics = 24;

Parameters
Name Description
index int
builderForValue MetricDescriptor.Builder
Returns
Type Description
Service.Builder

addMetricsBuilder()

public MetricDescriptor.Builder addMetricsBuilder()

Defines the metrics used by this service.

repeated .google.api.MetricDescriptor metrics = 24;

Returns
Type Description
MetricDescriptor.Builder

addMetricsBuilder(int index)

public MetricDescriptor.Builder addMetricsBuilder(int index)

Defines the metrics used by this service.

repeated .google.api.MetricDescriptor metrics = 24;

Parameter
Name Description
index int
Returns
Type Description
MetricDescriptor.Builder

addMonitoredResources(MonitoredResourceDescriptor value)

public Service.Builder addMonitoredResources(MonitoredResourceDescriptor value)

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
value MonitoredResourceDescriptor
Returns
Type Description
Service.Builder

addMonitoredResources(MonitoredResourceDescriptor.Builder builderForValue)

public Service.Builder addMonitoredResources(MonitoredResourceDescriptor.Builder builderForValue)

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
builderForValue MonitoredResourceDescriptor.Builder
Returns
Type Description
Service.Builder

addMonitoredResources(int index, MonitoredResourceDescriptor value)

public Service.Builder addMonitoredResources(int index, MonitoredResourceDescriptor value)

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;

Parameters
Name Description
index int
value MonitoredResourceDescriptor
Returns
Type Description
Service.Builder

addMonitoredResources(int index, MonitoredResourceDescriptor.Builder builderForValue)

public Service.Builder addMonitoredResources(int index, MonitoredResourceDescriptor.Builder builderForValue)

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;

Parameters
Name Description
index int
builderForValue MonitoredResourceDescriptor.Builder
Returns
Type Description
Service.Builder

addMonitoredResourcesBuilder()

public MonitoredResourceDescriptor.Builder addMonitoredResourcesBuilder()

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
MonitoredResourceDescriptor.Builder

addMonitoredResourcesBuilder(int index)

public MonitoredResourceDescriptor.Builder addMonitoredResourcesBuilder(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.Builder

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

public Service.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)
Parameters
Name Description
field FieldDescriptor
value Object
Returns
Type Description
Service.Builder
Overrides

addTypes(Type value)

public Service.Builder addTypes(Type value)

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
value Type
Returns
Type Description
Service.Builder

addTypes(Type.Builder builderForValue)

public Service.Builder addTypes(Type.Builder builderForValue)

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
builderForValue Builder
Returns
Type Description
Service.Builder

addTypes(int index, Type value)

public Service.Builder addTypes(int index, Type value)

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;

Parameters
Name Description
index int
value Type
Returns
Type Description
Service.Builder

addTypes(int index, Type.Builder builderForValue)

public Service.Builder addTypes(int index, Type.Builder builderForValue)

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;

Parameters
Name Description
index int
builderForValue Builder
Returns
Type Description
Service.Builder

addTypesBuilder()

public Type.Builder addTypesBuilder()

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
Builder

addTypesBuilder(int index)

public Type.Builder addTypesBuilder(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
Builder

build()

public Service build()
Returns
Type Description
Service

buildPartial()

public Service buildPartial()
Returns
Type Description
Service

clear()

public Service.Builder clear()
Returns
Type Description
Service.Builder
Overrides

clearApis()

public Service.Builder clearApis()

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
Service.Builder

clearAuthentication()

public Service.Builder clearAuthentication()

Auth configuration.

.google.api.Authentication authentication = 11;

Returns
Type Description
Service.Builder

clearBackend()

public Service.Builder clearBackend()

API backend configuration.

.google.api.Backend backend = 8;

Returns
Type Description
Service.Builder

clearBilling()

public Service.Builder clearBilling()

Billing configuration.

.google.api.Billing billing = 26;

Returns
Type Description
Service.Builder

clearConfigVersion()

public Service.Builder clearConfigVersion()

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
Service.Builder

clearContext()

public Service.Builder clearContext()

Context configuration.

.google.api.Context context = 12;

Returns
Type Description
Service.Builder

clearControl()

public Service.Builder clearControl()

Configuration for the service control plane.

.google.api.Control control = 21;

Returns
Type Description
Service.Builder

clearDocumentation()

public Service.Builder clearDocumentation()

Additional API documentation.

.google.api.Documentation documentation = 6;

Returns
Type Description
Service.Builder

clearEndpoints()

public Service.Builder clearEndpoints()

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
Service.Builder

clearEnums()

public Service.Builder clearEnums()

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
Service.Builder

clearField(Descriptors.FieldDescriptor field)

public Service.Builder clearField(Descriptors.FieldDescriptor field)
Parameter
Name Description
field FieldDescriptor
Returns
Type Description
Service.Builder
Overrides

clearHttp()

public Service.Builder clearHttp()

HTTP configuration.

.google.api.Http http = 9;

Returns
Type Description
Service.Builder

clearId()

public Service.Builder clearId()

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
Service.Builder

This builder for chaining.

clearLogging()

public Service.Builder clearLogging()

Logging configuration.

.google.api.Logging logging = 27;

Returns
Type Description
Service.Builder

clearLogs()

public Service.Builder clearLogs()

Defines the logs used by this service.

repeated .google.api.LogDescriptor logs = 23;

Returns
Type Description
Service.Builder

clearMetrics()

public Service.Builder clearMetrics()

Defines the metrics used by this service.

repeated .google.api.MetricDescriptor metrics = 24;

Returns
Type Description
Service.Builder

clearMonitoredResources()

public Service.Builder clearMonitoredResources()

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
Service.Builder

clearMonitoring()

public Service.Builder clearMonitoring()

Monitoring configuration.

.google.api.Monitoring monitoring = 28;

Returns
Type Description
Service.Builder

clearName()

public Service.Builder clearName()

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
Service.Builder

This builder for chaining.

clearOneof(Descriptors.OneofDescriptor oneof)

public Service.Builder clearOneof(Descriptors.OneofDescriptor oneof)
Parameter
Name Description
oneof OneofDescriptor
Returns
Type Description
Service.Builder
Overrides

clearProducerProjectId()

public Service.Builder clearProducerProjectId()

The Google project that owns this service.

string producer_project_id = 22;

Returns
Type Description
Service.Builder

This builder for chaining.

clearPublishing()

public Service.Builder clearPublishing()

Settings for Google Cloud Client libraries generated from APIs defined as protocol buffers.

.google.api.Publishing publishing = 45;

Returns
Type Description
Service.Builder

clearQuota()

public Service.Builder clearQuota()

Quota configuration.

.google.api.Quota quota = 10;

Returns
Type Description
Service.Builder

clearSourceInfo()

public Service.Builder clearSourceInfo()

Output only. The source information for this configuration if available.

.google.api.SourceInfo source_info = 37;

Returns
Type Description
Service.Builder

clearSystemParameters()

public Service.Builder clearSystemParameters()

System parameter configuration.

.google.api.SystemParameters system_parameters = 29;

Returns
Type Description
Service.Builder

clearTitle()

public Service.Builder clearTitle()

The product title for this service, it is the name displayed in Google Cloud Console.

string title = 2;

Returns
Type Description
Service.Builder

This builder for chaining.

clearTypes()

public Service.Builder clearTypes()

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
Service.Builder

clearUsage()

public Service.Builder clearUsage()

Configuration controlling usage of this service.

.google.api.Usage usage = 15;

Returns
Type Description
Service.Builder

clone()

public Service.Builder clone()
Returns
Type Description
Service.Builder
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

getApisBuilder(int index)

public Api.Builder getApisBuilder(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
Builder

getApisBuilderList()

public List<Api.Builder> getApisBuilderList()

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<Builder>

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.

getAuthenticationBuilder()

public Authentication.Builder getAuthenticationBuilder()

Auth configuration.

.google.api.Authentication authentication = 11;

Returns
Type Description
Authentication.Builder

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.

getBackendBuilder()

public Backend.Builder getBackendBuilder()

API backend configuration.

.google.api.Backend backend = 8;

Returns
Type Description
Backend.Builder

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.

getBillingBuilder()

public Billing.Builder getBillingBuilder()

Billing configuration.

.google.api.Billing billing = 26;

Returns
Type Description
Billing.Builder

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.

getConfigVersionBuilder()

public UInt32Value.Builder getConfigVersionBuilder()

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
Builder

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.

getContextBuilder()

public Context.Builder getContextBuilder()

Context configuration.

.google.api.Context context = 12;

Returns
Type Description
Context.Builder

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.

getControlBuilder()

public Control.Builder getControlBuilder()

Configuration for the service control plane.

.google.api.Control control = 21;

Returns
Type Description
Control.Builder

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

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()
Returns
Type Description
Descriptor
Overrides

getDocumentation()

public Documentation getDocumentation()

Additional API documentation.

.google.api.Documentation documentation = 6;

Returns
Type Description
Documentation

The documentation.

getDocumentationBuilder()

public Documentation.Builder getDocumentationBuilder()

Additional API documentation.

.google.api.Documentation documentation = 6;

Returns
Type Description
Documentation.Builder

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

getEndpointsBuilder(int index)

public Endpoint.Builder getEndpointsBuilder(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.Builder

getEndpointsBuilderList()

public List<Endpoint.Builder> getEndpointsBuilderList()

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<Builder>

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

getEnumsBuilder(int index)

public Enum.Builder getEnumsBuilder(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
Builder

getEnumsBuilderList()

public List<Enum.Builder> getEnumsBuilderList()

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<Builder>

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.

getHttpBuilder()

public Http.Builder getHttpBuilder()

HTTP configuration.

.google.api.Http http = 9;

Returns
Type Description
Http.Builder

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.

getLoggingBuilder()

public Logging.Builder getLoggingBuilder()

Logging configuration.

.google.api.Logging logging = 27;

Returns
Type Description
Logging.Builder

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

getLogsBuilder(int index)

public LogDescriptor.Builder getLogsBuilder(int index)

Defines the logs used by this service.

repeated .google.api.LogDescriptor logs = 23;

Parameter
Name Description
index int
Returns
Type Description
LogDescriptor.Builder

getLogsBuilderList()

public List<LogDescriptor.Builder> getLogsBuilderList()

Defines the logs used by this service.

repeated .google.api.LogDescriptor logs = 23;

Returns
Type Description
List<Builder>

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

getMetricsBuilder(int index)

public MetricDescriptor.Builder getMetricsBuilder(int index)

Defines the metrics used by this service.

repeated .google.api.MetricDescriptor metrics = 24;

Parameter
Name Description
index int
Returns
Type Description
MetricDescriptor.Builder

getMetricsBuilderList()

public List<MetricDescriptor.Builder> getMetricsBuilderList()

Defines the metrics used by this service.

repeated .google.api.MetricDescriptor metrics = 24;

Returns
Type Description
List<Builder>

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

getMonitoredResourcesBuilder(int index)

public MonitoredResourceDescriptor.Builder getMonitoredResourcesBuilder(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.Builder

getMonitoredResourcesBuilderList()

public List<MonitoredResourceDescriptor.Builder> getMonitoredResourcesBuilderList()

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<Builder>

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.

getMonitoringBuilder()

public Monitoring.Builder getMonitoringBuilder()

Monitoring configuration.

.google.api.Monitoring monitoring = 28;

Returns
Type Description
Monitoring.Builder

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.

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.

getPublishingBuilder()

public Publishing.Builder getPublishingBuilder()

Settings for Google Cloud Client libraries generated from APIs defined as protocol buffers.

.google.api.Publishing publishing = 45;

Returns
Type Description
Publishing.Builder

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.

getQuotaBuilder()

public Quota.Builder getQuotaBuilder()

Quota configuration.

.google.api.Quota quota = 10;

Returns
Type Description
Quota.Builder

getQuotaOrBuilder()

public QuotaOrBuilder getQuotaOrBuilder()

Quota configuration.

.google.api.Quota quota = 10;

Returns
Type Description
QuotaOrBuilder

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.

getSourceInfoBuilder()

public SourceInfo.Builder getSourceInfoBuilder()

Output only. The source information for this configuration if available.

.google.api.SourceInfo source_info = 37;

Returns
Type Description
SourceInfo.Builder

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.

getSystemParametersBuilder()

public SystemParameters.Builder getSystemParametersBuilder()

System parameter configuration.

.google.api.SystemParameters system_parameters = 29;

Returns
Type Description
SystemParameters.Builder

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

getTypesBuilder(int index)

public Type.Builder getTypesBuilder(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
Builder

getTypesBuilderList()

public List<Type.Builder> getTypesBuilderList()

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<Builder>

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.

getUsageBuilder()

public Usage.Builder getUsageBuilder()

Configuration controlling usage of this service.

.google.api.Usage usage = 15;

Returns
Type Description
Usage.Builder

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.

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Type Description
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

mergeAuthentication(Authentication value)

public Service.Builder mergeAuthentication(Authentication value)

Auth configuration.

.google.api.Authentication authentication = 11;

Parameter
Name Description
value Authentication
Returns
Type Description
Service.Builder

mergeBackend(Backend value)

public Service.Builder mergeBackend(Backend value)

API backend configuration.

.google.api.Backend backend = 8;

Parameter
Name Description
value Backend
Returns
Type Description
Service.Builder

mergeBilling(Billing value)

public Service.Builder mergeBilling(Billing value)

Billing configuration.

.google.api.Billing billing = 26;

Parameter
Name Description
value Billing
Returns
Type Description
Service.Builder

mergeConfigVersion(UInt32Value value)

public Service.Builder mergeConfigVersion(UInt32Value value)

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;

Parameter
Name Description
value UInt32Value
Returns
Type Description
Service.Builder

mergeContext(Context value)

public Service.Builder mergeContext(Context value)

Context configuration.

.google.api.Context context = 12;

Parameter
Name Description
value Context
Returns
Type Description
Service.Builder

mergeControl(Control value)

public Service.Builder mergeControl(Control value)

Configuration for the service control plane.

.google.api.Control control = 21;

Parameter
Name Description
value Control
Returns
Type Description
Service.Builder

mergeDocumentation(Documentation value)

public Service.Builder mergeDocumentation(Documentation value)

Additional API documentation.

.google.api.Documentation documentation = 6;

Parameter
Name Description
value Documentation
Returns
Type Description
Service.Builder

mergeFrom(Service other)

public Service.Builder mergeFrom(Service other)
Parameter
Name Description
other Service
Returns
Type Description
Service.Builder

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public Service.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
Service.Builder
Overrides
Exceptions
Type Description
IOException

mergeFrom(Message other)

public Service.Builder mergeFrom(Message other)
Parameter
Name Description
other Message
Returns
Type Description
Service.Builder
Overrides

mergeHttp(Http value)

public Service.Builder mergeHttp(Http value)

HTTP configuration.

.google.api.Http http = 9;

Parameter
Name Description
value Http
Returns
Type Description
Service.Builder

mergeLogging(Logging value)

public Service.Builder mergeLogging(Logging value)

Logging configuration.

.google.api.Logging logging = 27;

Parameter
Name Description
value Logging
Returns
Type Description
Service.Builder

mergeMonitoring(Monitoring value)

public Service.Builder mergeMonitoring(Monitoring value)

Monitoring configuration.

.google.api.Monitoring monitoring = 28;

Parameter
Name Description
value Monitoring
Returns
Type Description
Service.Builder

mergePublishing(Publishing value)

public Service.Builder mergePublishing(Publishing value)

Settings for Google Cloud Client libraries generated from APIs defined as protocol buffers.

.google.api.Publishing publishing = 45;

Parameter
Name Description
value Publishing
Returns
Type Description
Service.Builder

mergeQuota(Quota value)

public Service.Builder mergeQuota(Quota value)

Quota configuration.

.google.api.Quota quota = 10;

Parameter
Name Description
value Quota
Returns
Type Description
Service.Builder

mergeSourceInfo(SourceInfo value)

public Service.Builder mergeSourceInfo(SourceInfo value)

Output only. The source information for this configuration if available.

.google.api.SourceInfo source_info = 37;

Parameter
Name Description
value SourceInfo
Returns
Type Description
Service.Builder

mergeSystemParameters(SystemParameters value)

public Service.Builder mergeSystemParameters(SystemParameters value)

System parameter configuration.

.google.api.SystemParameters system_parameters = 29;

Parameter
Name Description
value SystemParameters
Returns
Type Description
Service.Builder

mergeUnknownFields(UnknownFieldSet unknownFields)

public final Service.Builder mergeUnknownFields(UnknownFieldSet unknownFields)
Parameter
Name Description
unknownFields UnknownFieldSet
Returns
Type Description
Service.Builder
Overrides

mergeUsage(Usage value)

public Service.Builder mergeUsage(Usage value)

Configuration controlling usage of this service.

.google.api.Usage usage = 15;

Parameter
Name Description
value Usage
Returns
Type Description
Service.Builder

removeApis(int index)

public Service.Builder removeApis(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
Service.Builder

removeEndpoints(int index)

public Service.Builder removeEndpoints(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
Service.Builder

removeEnums(int index)

public Service.Builder removeEnums(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
Service.Builder

removeLogs(int index)

public Service.Builder removeLogs(int index)

Defines the logs used by this service.

repeated .google.api.LogDescriptor logs = 23;

Parameter
Name Description
index int
Returns
Type Description
Service.Builder

removeMetrics(int index)

public Service.Builder removeMetrics(int index)

Defines the metrics used by this service.

repeated .google.api.MetricDescriptor metrics = 24;

Parameter
Name Description
index int
Returns
Type Description
Service.Builder

removeMonitoredResources(int index)

public Service.Builder removeMonitoredResources(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
Service.Builder

removeTypes(int index)

public Service.Builder removeTypes(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
Service.Builder

setApis(int index, Api value)

public Service.Builder setApis(int index, Api value)

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;

Parameters
Name Description
index int
value Api
Returns
Type Description
Service.Builder

setApis(int index, Api.Builder builderForValue)

public Service.Builder setApis(int index, Api.Builder builderForValue)

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;

Parameters
Name Description
index int
builderForValue Builder
Returns
Type Description
Service.Builder

setAuthentication(Authentication value)

public Service.Builder setAuthentication(Authentication value)

Auth configuration.

.google.api.Authentication authentication = 11;

Parameter
Name Description
value Authentication
Returns
Type Description
Service.Builder

setAuthentication(Authentication.Builder builderForValue)

public Service.Builder setAuthentication(Authentication.Builder builderForValue)

Auth configuration.

.google.api.Authentication authentication = 11;

Parameter
Name Description
builderForValue Authentication.Builder
Returns
Type Description
Service.Builder

setBackend(Backend value)

public Service.Builder setBackend(Backend value)

API backend configuration.

.google.api.Backend backend = 8;

Parameter
Name Description
value Backend
Returns
Type Description
Service.Builder

setBackend(Backend.Builder builderForValue)

public Service.Builder setBackend(Backend.Builder builderForValue)

API backend configuration.

.google.api.Backend backend = 8;

Parameter
Name Description
builderForValue Backend.Builder
Returns
Type Description
Service.Builder

setBilling(Billing value)

public Service.Builder setBilling(Billing value)

Billing configuration.

.google.api.Billing billing = 26;

Parameter
Name Description
value Billing
Returns
Type Description
Service.Builder

setBilling(Billing.Builder builderForValue)

public Service.Builder setBilling(Billing.Builder builderForValue)

Billing configuration.

.google.api.Billing billing = 26;

Parameter
Name Description
builderForValue Billing.Builder
Returns
Type Description
Service.Builder