Interface ServiceOrBuilder (2.10.0)

Version 2.10.0

• 2.50.0 (latest)
• 2.49.0
• 2.48.0
• 2.46.0
• 2.45.1
• 2.44.0
• 2.43.0
• 2.42.0
• 2.41.0
• 2.40.0
• 2.39.1
• 2.38.0
• 2.37.1
• 2.36.0
• 2.34.0
• 2.33.0
• 2.32.0
• 2.30.0
• 2.29.0
• 2.28.0
• 2.27.0
• 2.26.0
• 2.25.1
• 2.24.0
• 2.23.1
• 2.22.1
• 2.21.1
• 2.15.0
• 2.14.3
• 2.13.0
• 2.12.0
• 2.11.0
• 2.10.0
• 2.9.6
• 2.8.4
• 2.7.4

public interface ServiceOrBuilder extends MessageOrBuilder

Implements

MessageOrBuilder

Methods

getApis(int index)

public abstract 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 abstract 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 abstract 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 abstract 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 abstract 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 abstract Authentication getAuthentication()

Auth configuration.

.google.api.Authentication authentication = 11;

Returns

Type	Description
Authentication	The authentication.

getAuthenticationOrBuilder()

public abstract AuthenticationOrBuilder getAuthenticationOrBuilder()

Auth configuration.

.google.api.Authentication authentication = 11;

Returns

Type	Description
AuthenticationOrBuilder

getBackend()

public abstract Backend getBackend()

API backend configuration.

.google.api.Backend backend = 8;

Returns

Type	Description
Backend	The backend.

getBackendOrBuilder()

public abstract BackendOrBuilder getBackendOrBuilder()

API backend configuration.

.google.api.Backend backend = 8;

Returns

Type	Description
BackendOrBuilder

getBilling()

public abstract Billing getBilling()

Billing configuration.

.google.api.Billing billing = 26;

Returns

Type	Description
Billing	The billing.

getBillingOrBuilder()

public abstract BillingOrBuilder getBillingOrBuilder()

Billing configuration.

.google.api.Billing billing = 26;

Returns

Type	Description
BillingOrBuilder

getConfigVersion() (deprecated)

public abstract UInt32Value getConfigVersion()

Deprecated. google.api.Service.config_version is deprecated. See google/api/service.proto;l=170

Obsolete. Do not use. This field has no semantic meaning. The service config compiler always sets this field to 3.

.google.protobuf.UInt32Value config_version = 20 [deprecated = true];

Returns

Type	Description
UInt32Value	The configVersion.

getConfigVersionOrBuilder()

public abstract UInt32ValueOrBuilder getConfigVersionOrBuilder()

Obsolete. Do not use. This field has no semantic meaning. The service config compiler always sets this field to 3.

.google.protobuf.UInt32Value config_version = 20 [deprecated = true];

Returns

Type	Description
UInt32ValueOrBuilder

getContext()

public abstract Context getContext()

Context configuration.

.google.api.Context context = 12;

Returns

Type	Description
Context	The context.

getContextOrBuilder()

public abstract ContextOrBuilder getContextOrBuilder()

Context configuration.

.google.api.Context context = 12;

Returns

Type	Description
ContextOrBuilder

getControl()

public abstract Control getControl()

Configuration for the service control plane.

.google.api.Control control = 21;

Returns

Type	Description
Control	The control.

getControlOrBuilder()

public abstract ControlOrBuilder getControlOrBuilder()

Configuration for the service control plane.

.google.api.Control control = 21;

Returns

Type	Description
ControlOrBuilder

getDocumentation()

public abstract Documentation getDocumentation()

Additional API documentation.

.google.api.Documentation documentation = 6;

Returns

Type	Description
Documentation	The documentation.

getDocumentationOrBuilder()

public abstract DocumentationOrBuilder getDocumentationOrBuilder()

Additional API documentation.

.google.api.Documentation documentation = 6;

Returns

Type	Description
DocumentationOrBuilder

getEndpoints(int index)

public abstract 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 abstract 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 abstract 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 abstract 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 abstract 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 abstract Enum getEnums(int index)

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

• name: google.someapi.v1.SomeEnum

repeated .google.protobuf.Enum enums = 5;

Parameter

Name	Description
index	int

Returns

Type	Description
Enum

getEnumsCount()

public abstract int getEnumsCount()

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

• name: google.someapi.v1.SomeEnum

repeated .google.protobuf.Enum enums = 5;

Returns

Type	Description
int

getEnumsList()

public abstract List<Enum> getEnumsList()

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

• name: google.someapi.v1.SomeEnum

repeated .google.protobuf.Enum enums = 5;

Returns

Type	Description
List<Enum>

getEnumsOrBuilder(int index)

public abstract EnumOrBuilder getEnumsOrBuilder(int index)

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

• name: google.someapi.v1.SomeEnum

repeated .google.protobuf.Enum enums = 5;

Parameter

Name	Description
index	int

Returns

Type	Description
EnumOrBuilder

getEnumsOrBuilderList()

public abstract List<? extends EnumOrBuilder> getEnumsOrBuilderList()

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

• name: google.someapi.v1.SomeEnum

repeated .google.protobuf.Enum enums = 5;

Returns

Type	Description
List<? extends com.google.protobuf.EnumOrBuilder>

getHttp()

public abstract Http getHttp()

HTTP configuration.

.google.api.Http http = 9;

Returns

Type	Description
Http	The http.

getHttpOrBuilder()

public abstract HttpOrBuilder getHttpOrBuilder()

HTTP configuration.

.google.api.Http http = 9;

Returns

Type	Description
HttpOrBuilder

getId()

public abstract 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 abstract 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 abstract Logging getLogging()

Logging configuration.

.google.api.Logging logging = 27;

Returns

Type	Description
Logging	The logging.

getLoggingOrBuilder()

public abstract LoggingOrBuilder getLoggingOrBuilder()

Logging configuration.

.google.api.Logging logging = 27;

Returns

Type	Description
LoggingOrBuilder

getLogs(int index)

public abstract 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 abstract int getLogsCount()

Defines the logs used by this service.

repeated .google.api.LogDescriptor logs = 23;

Returns

Type	Description
int

getLogsList()

public abstract 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 abstract 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 abstract 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 abstract 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 abstract int getMetricsCount()

Defines the metrics used by this service.

repeated .google.api.MetricDescriptor metrics = 24;

Returns

Type	Description
int

getMetricsList()

public abstract 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 abstract 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 abstract 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 abstract 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 abstract 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 abstract 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 abstract 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 abstract 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 abstract Monitoring getMonitoring()

Monitoring configuration.

.google.api.Monitoring monitoring = 28;

Returns

Type	Description
Monitoring	The monitoring.

getMonitoringOrBuilder()

public abstract MonitoringOrBuilder getMonitoringOrBuilder()

Monitoring configuration.

.google.api.Monitoring monitoring = 28;

Returns

Type	Description
MonitoringOrBuilder

getName()

public abstract 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 abstract 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 abstract String getProducerProjectId()

The Google project that owns this service.

string producer_project_id = 22;

Returns

Type	Description
String	The producerProjectId.

getProducerProjectIdBytes()

public abstract ByteString getProducerProjectIdBytes()

The Google project that owns this service.

string producer_project_id = 22;

Returns

Type	Description
ByteString	The bytes for producerProjectId.

getQuota()

public abstract Quota getQuota()

Quota configuration.

.google.api.Quota quota = 10;

Returns

Type	Description
Quota	The quota.

getQuotaOrBuilder()

public abstract QuotaOrBuilder getQuotaOrBuilder()

Quota configuration.

.google.api.Quota quota = 10;

Returns

Type	Description
QuotaOrBuilder

getSourceInfo()

public abstract 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 abstract SourceInfoOrBuilder getSourceInfoOrBuilder()

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

.google.api.SourceInfo source_info = 37;

Returns

Type	Description
SourceInfoOrBuilder

getSystemParameters()

public abstract SystemParameters getSystemParameters()

System parameter configuration.

.google.api.SystemParameters system_parameters = 29;

Returns

Type	Description
SystemParameters	The systemParameters.

getSystemParametersOrBuilder()

public abstract SystemParametersOrBuilder getSystemParametersOrBuilder()

System parameter configuration.

.google.api.SystemParameters system_parameters = 29;

Returns

Type	Description
SystemParametersOrBuilder

getTitle()

public abstract String getTitle()

The product title for this service.

string title = 2;

Returns

Type	Description
String	The title.

getTitleBytes()

public abstract ByteString getTitleBytes()

The product title for this service.

string title = 2;

Returns

Type	Description
ByteString	The bytes for title.

getTypes(int index)

public abstract Type getTypes(int index)

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

• name: google.protobuf.Int32

repeated .google.protobuf.Type types = 4;

Parameter

Name	Description
index	int

Returns

Type	Description
Type

getTypesCount()

public abstract int getTypesCount()

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

• name: google.protobuf.Int32

repeated .google.protobuf.Type types = 4;

Returns

Type	Description
int

getTypesList()

public abstract List<Type> getTypesList()

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

• name: google.protobuf.Int32

repeated .google.protobuf.Type types = 4;

Returns

Type	Description
List<Type>

getTypesOrBuilder(int index)

public abstract TypeOrBuilder getTypesOrBuilder(int index)

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

• name: google.protobuf.Int32

repeated .google.protobuf.Type types = 4;

Parameter

Name	Description
index	int

Returns

Type	Description
TypeOrBuilder

getTypesOrBuilderList()

public abstract List<? extends TypeOrBuilder> getTypesOrBuilderList()

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

• name: google.protobuf.Int32

repeated .google.protobuf.Type types = 4;

Returns

Type	Description
List<? extends com.google.protobuf.TypeOrBuilder>

getUsage()

public abstract Usage getUsage()

Configuration controlling usage of this service.

.google.api.Usage usage = 15;

Returns

Type	Description
Usage	The usage.

getUsageOrBuilder()

public abstract UsageOrBuilder getUsageOrBuilder()

Configuration controlling usage of this service.

.google.api.Usage usage = 15;

Returns

Type	Description
UsageOrBuilder

hasAuthentication()

public abstract boolean hasAuthentication()

Auth configuration.

.google.api.Authentication authentication = 11;

Returns

Type	Description
boolean	Whether the authentication field is set.

hasBackend()

public abstract boolean hasBackend()

API backend configuration.

.google.api.Backend backend = 8;

Returns

Type	Description
boolean	Whether the backend field is set.

hasBilling()

public abstract boolean hasBilling()

Billing configuration.

.google.api.Billing billing = 26;

Returns

Type	Description
boolean	Whether the billing field is set.

hasConfigVersion() (deprecated)

public abstract boolean hasConfigVersion()

Deprecated. google.api.Service.config_version is deprecated. See google/api/service.proto;l=170

Obsolete. Do not use. This field has no semantic meaning. The service config compiler always sets this field to 3.

.google.protobuf.UInt32Value config_version = 20 [deprecated = true];

Returns

Type	Description
boolean	Whether the configVersion field is set.

hasContext()

public abstract boolean hasContext()

Context configuration.

.google.api.Context context = 12;

Returns

Type	Description
boolean	Whether the context field is set.

hasControl()

public abstract 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 abstract boolean hasDocumentation()

Additional API documentation.

.google.api.Documentation documentation = 6;

Returns

Type	Description
boolean	Whether the documentation field is set.

hasHttp()

public abstract boolean hasHttp()

HTTP configuration.

.google.api.Http http = 9;

Returns

Type	Description
boolean	Whether the http field is set.

hasLogging()

public abstract boolean hasLogging()

Logging configuration.

.google.api.Logging logging = 27;

Returns

Type	Description
boolean	Whether the logging field is set.

hasMonitoring()

public abstract boolean hasMonitoring()

Monitoring configuration.

.google.api.Monitoring monitoring = 28;

Returns

Type	Description
boolean	Whether the monitoring field is set.

hasQuota()

public abstract boolean hasQuota()

Quota configuration.

.google.api.Quota quota = 10;

Returns

Type	Description
boolean	Whether the quota field is set.

hasSourceInfo()

public abstract 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 abstract boolean hasSystemParameters()

System parameter configuration.

.google.api.SystemParameters system_parameters = 29;

Returns

Type	Description
boolean	Whether the systemParameters field is set.

hasUsage()

public abstract boolean hasUsage()

Configuration controlling usage of this service.

.google.api.Usage usage = 15;

Returns

Type	Description
boolean	Whether the usage field is set.