public interface ServiceOrBuilder extends MessageOrBuilderImplements
MessageOrBuilderMethods
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;
| Name | Description |
index | int |
| 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;
| 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;
| 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;
| Name | Description |
index | int |
| 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;
| Type | Description |
List<? extends com.google.protobuf.ApiOrBuilder> |
getAuthentication()
public abstract Authentication getAuthentication()Auth configuration.
.google.api.Authentication authentication = 11;
| Type | Description |
Authentication | The authentication. |
getAuthenticationOrBuilder()
public abstract AuthenticationOrBuilder getAuthenticationOrBuilder()Auth configuration.
.google.api.Authentication authentication = 11;
| Type | Description |
AuthenticationOrBuilder |
getBackend()
public abstract Backend getBackend()API backend configuration.
.google.api.Backend backend = 8;
| Type | Description |
Backend | The backend. |
getBackendOrBuilder()
public abstract BackendOrBuilder getBackendOrBuilder()API backend configuration.
.google.api.Backend backend = 8;
| Type | Description |
BackendOrBuilder |
getBilling()
public abstract Billing getBilling()Billing configuration.
.google.api.Billing billing = 26;
| Type | Description |
Billing | The billing. |
getBillingOrBuilder()
public abstract BillingOrBuilder getBillingOrBuilder()Billing configuration.
.google.api.Billing billing = 26;
| Type | Description |
BillingOrBuilder |
getConfigVersion()
public abstract 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;
| 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;
| Type | Description |
UInt32ValueOrBuilder |
getContext()
public abstract Context getContext()Context configuration.
.google.api.Context context = 12;
| Type | Description |
Context | The context. |
getContextOrBuilder()
public abstract ContextOrBuilder getContextOrBuilder()Context configuration.
.google.api.Context context = 12;
| Type | Description |
ContextOrBuilder |
getControl()
public abstract Control getControl()Configuration for the service control plane.
.google.api.Control control = 21;
| Type | Description |
Control | The control. |
getControlOrBuilder()
public abstract ControlOrBuilder getControlOrBuilder()Configuration for the service control plane.
.google.api.Control control = 21;
| Type | Description |
ControlOrBuilder |
getDocumentation()
public abstract Documentation getDocumentation()Additional API documentation.
.google.api.Documentation documentation = 6;
| Type | Description |
Documentation | The documentation. |
getDocumentationOrBuilder()
public abstract DocumentationOrBuilder getDocumentationOrBuilder()Additional API documentation.
.google.api.Documentation documentation = 6;
| 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;
| Name | Description |
index | int |
| 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;
| 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;
| 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;
| Name | Description |
index | int |
| 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;
| 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 by the configuration author. Example:
enums:
- name: google.someapi.v1.SomeEnum
repeated .google.protobuf.Enum enums = 5;
| Name | Description |
index | int |
| 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 by the configuration author. Example:
enums:
- name: google.someapi.v1.SomeEnum
repeated .google.protobuf.Enum enums = 5;
| 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 by the configuration author. Example:
enums:
- name: google.someapi.v1.SomeEnum
repeated .google.protobuf.Enum enums = 5;
| 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 by the configuration author. Example:
enums:
- name: google.someapi.v1.SomeEnum
repeated .google.protobuf.Enum enums = 5;
| Name | Description |
index | int |
| 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 by the configuration author. Example:
enums:
- name: google.someapi.v1.SomeEnum
repeated .google.protobuf.Enum enums = 5;
| Type | Description |
List<? extends com.google.protobuf.EnumOrBuilder> |
getHttp()
public abstract Http getHttp()HTTP configuration.
.google.api.Http http = 9;
| Type | Description |
Http | The http. |
getHttpOrBuilder()
public abstract HttpOrBuilder getHttpOrBuilder()HTTP configuration.
.google.api.Http http = 9;
| 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;
| 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;
| Type | Description |
ByteString | The bytes for id. |
getLogging()
public abstract Logging getLogging()Logging configuration.
.google.api.Logging logging = 27;
| Type | Description |
Logging | The logging. |
getLoggingOrBuilder()
public abstract LoggingOrBuilder getLoggingOrBuilder()Logging configuration.
.google.api.Logging logging = 27;
| 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;
| Name | Description |
index | int |
| Type | Description |
LogDescriptor |
getLogsCount()
public abstract int getLogsCount()Defines the logs used by this service.
repeated .google.api.LogDescriptor logs = 23;
| Type | Description |
int |
getLogsList()
public abstract List<LogDescriptor> getLogsList()Defines the logs used by this service.
repeated .google.api.LogDescriptor logs = 23;
| 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;
| Name | Description |
index | int |
| Type | Description |
LogDescriptorOrBuilder |
getLogsOrBuilderList()
public abstract List<? extends LogDescriptorOrBuilder> getLogsOrBuilderList()Defines the logs used by this service.
repeated .google.api.LogDescriptor logs = 23;
| Type | Description |
List<? extends com.google.api.LogDescriptorOrBuilder> |
getMetrics(int index)
public abstract MetricDescriptor getMetrics(int index)Defines the metrics used by this service.
repeated .google.api.MetricDescriptor metrics = 24;
| Name | Description |
index | int |
| Type | Description |
MetricDescriptor |
getMetricsCount()
public abstract int getMetricsCount()Defines the metrics used by this service.
repeated .google.api.MetricDescriptor metrics = 24;
| Type | Description |
int |
getMetricsList()
public abstract List<MetricDescriptor> getMetricsList()Defines the metrics used by this service.
repeated .google.api.MetricDescriptor metrics = 24;
| 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;
| Name | Description |
index | int |
| Type | Description |
MetricDescriptorOrBuilder |
getMetricsOrBuilderList()
public abstract List<? extends MetricDescriptorOrBuilder> getMetricsOrBuilderList()Defines the metrics used by this service.
repeated .google.api.MetricDescriptor metrics = 24;
| Type | Description |
List<? extends com.google.api.MetricDescriptorOrBuilder> |
getMonitoredResources(int index)
public 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;
| Name | Description |
index | int |
| 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;
| 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;
| 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;
| Name | Description |
index | int |
| 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;
| Type | Description |
List<? extends com.google.api.MonitoredResourceDescriptorOrBuilder> |
getMonitoring()
public abstract Monitoring getMonitoring()Monitoring configuration.
.google.api.Monitoring monitoring = 28;
| Type | Description |
Monitoring | The monitoring. |
getMonitoringOrBuilder()
public abstract MonitoringOrBuilder getMonitoringOrBuilder()Monitoring configuration.
.google.api.Monitoring monitoring = 28;
| 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;
| 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;
| Type | Description |
ByteString | The bytes for name. |
getProducerProjectId()
public abstract String getProducerProjectId()The Google project that owns this service.
string producer_project_id = 22;
| Type | Description |
String | The producerProjectId. |
getProducerProjectIdBytes()
public abstract ByteString getProducerProjectIdBytes()The Google project that owns this service.
string producer_project_id = 22;
| Type | Description |
ByteString | The bytes for producerProjectId. |
getPublishing()
public abstract Publishing getPublishing()Settings for Google Cloud Client libraries generated from APIs defined as protocol buffers.
.google.api.Publishing publishing = 45;
| Type | Description |
Publishing | The publishing. |
getPublishingOrBuilder()
public abstract PublishingOrBuilder getPublishingOrBuilder()Settings for Google Cloud Client libraries generated from APIs defined as protocol buffers.
.google.api.Publishing publishing = 45;
| Type | Description |
PublishingOrBuilder |
getQuota()
public abstract Quota getQuota()Quota configuration.
.google.api.Quota quota = 10;
| Type | Description |
Quota | The quota. |
getQuotaOrBuilder()
public abstract QuotaOrBuilder getQuotaOrBuilder()Quota configuration.
.google.api.Quota quota = 10;
| Type | Description |
QuotaOrBuilder |
getSourceInfo()
public abstract SourceInfo getSourceInfo()Output only. The source information for this configuration if available.
.google.api.SourceInfo source_info = 37;
| Type | Description |
SourceInfo | The sourceInfo. |
getSourceInfoOrBuilder()
public abstract SourceInfoOrBuilder getSourceInfoOrBuilder()Output only. The source information for this configuration if available.
.google.api.SourceInfo source_info = 37;
| Type | Description |
SourceInfoOrBuilder |
getSystemParameters()
public abstract SystemParameters getSystemParameters()System parameter configuration.
.google.api.SystemParameters system_parameters = 29;
| Type | Description |
SystemParameters | The systemParameters. |
getSystemParametersOrBuilder()
public abstract SystemParametersOrBuilder getSystemParametersOrBuilder()System parameter configuration.
.google.api.SystemParameters system_parameters = 29;
| Type | Description |
SystemParametersOrBuilder |
getTitle()
public abstract String getTitle()The product title for this service, it is the name displayed in Google Cloud Console.
string title = 2;
| Type | Description |
String | The title. |
getTitleBytes()
public abstract ByteString getTitleBytes()The product title for this service, it is the name displayed in Google Cloud Console.
string title = 2;
| 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 by the configuration author. Example:
types:
- name: google.protobuf.Int32
repeated .google.protobuf.Type types = 4;
| Name | Description |
index | int |
| 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 by the configuration author. Example:
types:
- name: google.protobuf.Int32
repeated .google.protobuf.Type types = 4;
| 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 by the configuration author. Example:
types:
- name: google.protobuf.Int32
repeated .google.protobuf.Type types = 4;
| 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 by the configuration author. Example:
types:
- name: google.protobuf.Int32
repeated .google.protobuf.Type types = 4;
| Name | Description |
index | int |
| 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 by the configuration author. Example:
types:
- name: google.protobuf.Int32
repeated .google.protobuf.Type types = 4;
| Type | Description |
List<? extends com.google.protobuf.TypeOrBuilder> |
getUsage()
public abstract Usage getUsage()Configuration controlling usage of this service.
.google.api.Usage usage = 15;
| Type | Description |
Usage | The usage. |
getUsageOrBuilder()
public abstract UsageOrBuilder getUsageOrBuilder()Configuration controlling usage of this service.
.google.api.Usage usage = 15;
| Type | Description |
UsageOrBuilder |
hasAuthentication()
public abstract boolean hasAuthentication()Auth configuration.
.google.api.Authentication authentication = 11;
| Type | Description |
boolean | Whether the authentication field is set. |
hasBackend()
public abstract boolean hasBackend()API backend configuration.
.google.api.Backend backend = 8;
| Type | Description |
boolean | Whether the backend field is set. |
hasBilling()
public abstract boolean hasBilling()Billing configuration.
.google.api.Billing billing = 26;
| Type | Description |
boolean | Whether the billing field is set. |
hasConfigVersion()
public abstract 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;
| Type | Description |
boolean | Whether the configVersion field is set. |
hasContext()
public abstract boolean hasContext()Context configuration.
.google.api.Context context = 12;
| 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;
| Type | Description |
boolean | Whether the control field is set. |
hasDocumentation()
public abstract boolean hasDocumentation()Additional API documentation.
.google.api.Documentation documentation = 6;
| Type | Description |
boolean | Whether the documentation field is set. |
hasHttp()
public abstract boolean hasHttp()HTTP configuration.
.google.api.Http http = 9;
| Type | Description |
boolean | Whether the http field is set. |
hasLogging()
public abstract boolean hasLogging()Logging configuration.
.google.api.Logging logging = 27;
| Type | Description |
boolean | Whether the logging field is set. |
hasMonitoring()
public abstract boolean hasMonitoring()Monitoring configuration.
.google.api.Monitoring monitoring = 28;
| Type | Description |
boolean | Whether the monitoring field is set. |
hasPublishing()
public abstract boolean hasPublishing()Settings for Google Cloud Client libraries generated from APIs defined as protocol buffers.
.google.api.Publishing publishing = 45;
| Type | Description |
boolean | Whether the publishing field is set. |
hasQuota()
public abstract boolean hasQuota()Quota configuration.
.google.api.Quota quota = 10;
| 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;
| Type | Description |
boolean | Whether the sourceInfo field is set. |
hasSystemParameters()
public abstract boolean hasSystemParameters()System parameter configuration.
.google.api.SystemParameters system_parameters = 29;
| 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;
| Type | Description |
boolean | Whether the usage field is set. |