com.google.api.ServiceOrBuilder Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of googleapis-common-protos Show documentation
Show all versions of googleapis-common-protos Show documentation
GoogleAPI classes generated from core protos
The newest version!
// Generated by the protocol buffer compiler. DO NOT EDIT!
// source: google/api/service.proto
package com.google.api;
public interface ServiceOrBuilder extends
// @@protoc_insertion_point(interface_extends:google.api.Service)
com.google.protobuf.MessageOrBuilder {
/**
*
* The version of the service configuration. The config version may
* influence interpretation of the configuration, for example, to
* determine defaults. This is documented together with applicable
* options. The current default for the config version itself is `3`.
*
*
* optional .google.protobuf.UInt32Value config_version = 20;
*/
boolean hasConfigVersion();
/**
*
* The version of the service configuration. The config version may
* influence interpretation of the configuration, for example, to
* determine defaults. This is documented together with applicable
* options. The current default for the config version itself is `3`.
*
*
* optional .google.protobuf.UInt32Value config_version = 20;
*/
com.google.protobuf.UInt32Value getConfigVersion();
/**
*
* The version of the service configuration. The config version may
* influence interpretation of the configuration, for example, to
* determine defaults. This is documented together with applicable
* options. The current default for the config version itself is `3`.
*
*
* optional .google.protobuf.UInt32Value config_version = 20;
*/
com.google.protobuf.UInt32ValueOrBuilder getConfigVersionOrBuilder();
/**
*
* The DNS address at which this service is available,
* e.g. `calendar.googleapis.com`.
*
*
* optional string name = 1;
*/
java.lang.String getName();
/**
*
* The DNS address at which this service is available,
* e.g. `calendar.googleapis.com`.
*
*
* optional string name = 1;
*/
com.google.protobuf.ByteString
getNameBytes();
/**
*
* A unique ID for a specific instance of this message, typically assigned
* by the client for tracking purpose. If empty, the server may choose to
* generate one instead.
*
*
* optional string id = 33;
*/
java.lang.String getId();
/**
*
* A unique ID for a specific instance of this message, typically assigned
* by the client for tracking purpose. If empty, the server may choose to
* generate one instead.
*
*
* optional string id = 33;
*/
com.google.protobuf.ByteString
getIdBytes();
/**
*
* The product title associated with this service.
*
*
* optional string title = 2;
*/
java.lang.String getTitle();
/**
*
* The product title associated with this service.
*
*
* optional string title = 2;
*/
com.google.protobuf.ByteString
getTitleBytes();
/**
*
* The id of the Google developer project that owns the service.
* Members of this project can manage the service configuration,
* manage consumption of the service, etc.
*
*
* optional string producer_project_id = 22;
*/
java.lang.String getProducerProjectId();
/**
*
* The id of the Google developer project that owns the service.
* Members of this project can manage the service configuration,
* manage consumption of the service, etc.
*
*
* optional string producer_project_id = 22;
*/
com.google.protobuf.ByteString
getProducerProjectIdBytes();
/**
*
* A list of API interfaces exported by this service. Only the `name` field
* of the [google.protobuf.Api][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;
*/
java.util.List
getApisList();
/**
*
* A list of API interfaces exported by this service. Only the `name` field
* of the [google.protobuf.Api][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;
*/
com.google.protobuf.Api getApis(int index);
/**
*
* A list of API interfaces exported by this service. Only the `name` field
* of the [google.protobuf.Api][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;
*/
int getApisCount();
/**
*
* A list of API interfaces exported by this service. Only the `name` field
* of the [google.protobuf.Api][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;
*/
java.util.List
getApisOrBuilderList();
/**
*
* A list of API interfaces exported by this service. Only the `name` field
* of the [google.protobuf.Api][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;
*/
com.google.protobuf.ApiOrBuilder getApisOrBuilder(
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;
*/
java.util.List
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;
*/
com.google.protobuf.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;
*/
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;
*/
java.util.List
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;
*/
com.google.protobuf.TypeOrBuilder getTypesOrBuilder(
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;
*/
java.util.List
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;
*/
com.google.protobuf.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;
*/
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;
*/
java.util.List
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;
*/
com.google.protobuf.EnumOrBuilder getEnumsOrBuilder(
int index);
/**
*
* Additional API documentation.
*
*
* optional .google.api.Documentation documentation = 6;
*/
boolean hasDocumentation();
/**
*
* Additional API documentation.
*
*
* optional .google.api.Documentation documentation = 6;
*/
com.google.api.Documentation getDocumentation();
/**
*
* Additional API documentation.
*
*
* optional .google.api.Documentation documentation = 6;
*/
com.google.api.DocumentationOrBuilder getDocumentationOrBuilder();
/**
*
* API backend configuration.
*
*
* optional .google.api.Backend backend = 8;
*/
boolean hasBackend();
/**
*
* API backend configuration.
*
*
* optional .google.api.Backend backend = 8;
*/
com.google.api.Backend getBackend();
/**
*
* API backend configuration.
*
*
* optional .google.api.Backend backend = 8;
*/
com.google.api.BackendOrBuilder getBackendOrBuilder();
/**
*
* HTTP configuration.
*
*
* optional .google.api.Http http = 9;
*/
boolean hasHttp();
/**
*
* HTTP configuration.
*
*
* optional .google.api.Http http = 9;
*/
com.google.api.Http getHttp();
/**
*
* HTTP configuration.
*
*
* optional .google.api.Http http = 9;
*/
com.google.api.HttpOrBuilder getHttpOrBuilder();
/**
*
* Auth configuration.
*
*
* optional .google.api.Authentication authentication = 11;
*/
boolean hasAuthentication();
/**
*
* Auth configuration.
*
*
* optional .google.api.Authentication authentication = 11;
*/
com.google.api.Authentication getAuthentication();
/**
*
* Auth configuration.
*
*
* optional .google.api.Authentication authentication = 11;
*/
com.google.api.AuthenticationOrBuilder getAuthenticationOrBuilder();
/**
*
* Context configuration.
*
*
* optional .google.api.Context context = 12;
*/
boolean hasContext();
/**
*
* Context configuration.
*
*
* optional .google.api.Context context = 12;
*/
com.google.api.Context getContext();
/**
*
* Context configuration.
*
*
* optional .google.api.Context context = 12;
*/
com.google.api.ContextOrBuilder getContextOrBuilder();
/**
*
* Configuration controlling usage of this service.
*
*
* optional .google.api.Usage usage = 15;
*/
boolean hasUsage();
/**
*
* Configuration controlling usage of this service.
*
*
* optional .google.api.Usage usage = 15;
*/
com.google.api.Usage getUsage();
/**
*
* Configuration controlling usage of this service.
*
*
* optional .google.api.Usage usage = 15;
*/
com.google.api.UsageOrBuilder getUsageOrBuilder();
/**
*
* Configuration of per-consumer project properties.
*
*
* optional .google.api.ProjectProperties project_properties = 17;
*/
boolean hasProjectProperties();
/**
*
* Configuration of per-consumer project properties.
*
*
* optional .google.api.ProjectProperties project_properties = 17;
*/
com.google.api.ProjectProperties getProjectProperties();
/**
*
* Configuration of per-consumer project properties.
*
*
* optional .google.api.ProjectProperties project_properties = 17;
*/
com.google.api.ProjectPropertiesOrBuilder getProjectPropertiesOrBuilder();
/**
*
* Configuration for the service control plane.
*
*
* optional .google.api.Control control = 21;
*/
boolean hasControl();
/**
*
* Configuration for the service control plane.
*
*
* optional .google.api.Control control = 21;
*/
com.google.api.Control getControl();
/**
*
* Configuration for the service control plane.
*
*
* optional .google.api.Control control = 21;
*/
com.google.api.ControlOrBuilder getControlOrBuilder();
/**
*
* Defines the logs used by this service.
*
*
* repeated .google.api.LogDescriptor logs = 23;
*/
java.util.List
getLogsList();
/**
*
* Defines the logs used by this service.
*
*
* repeated .google.api.LogDescriptor logs = 23;
*/
com.google.api.LogDescriptor getLogs(int index);
/**
*
* Defines the logs used by this service.
*
*
* repeated .google.api.LogDescriptor logs = 23;
*/
int getLogsCount();
/**
*
* Defines the logs used by this service.
*
*
* repeated .google.api.LogDescriptor logs = 23;
*/
java.util.List
getLogsOrBuilderList();
/**
*
* Defines the logs used by this service.
*
*
* repeated .google.api.LogDescriptor logs = 23;
*/
com.google.api.LogDescriptorOrBuilder getLogsOrBuilder(
int index);
/**
*
* Defines the metrics used by this service.
*
*
* repeated .google.api.MetricDescriptor metrics = 24;
*/
java.util.List
getMetricsList();
/**
*
* Defines the metrics used by this service.
*
*
* repeated .google.api.MetricDescriptor metrics = 24;
*/
com.google.api.MetricDescriptor getMetrics(int index);
/**
*
* Defines the metrics used by this service.
*
*
* repeated .google.api.MetricDescriptor metrics = 24;
*/
int getMetricsCount();
/**
*
* Defines the metrics used by this service.
*
*
* repeated .google.api.MetricDescriptor metrics = 24;
*/
java.util.List
getMetricsOrBuilderList();
/**
*
* Defines the metrics used by this service.
*
*
* repeated .google.api.MetricDescriptor metrics = 24;
*/
com.google.api.MetricDescriptorOrBuilder getMetricsOrBuilder(
int index);
/**
*
* Defines the monitored resources used by this service. This is required
* by the [Service.monitoring][google.api.Service.monitoring] and [Service.logging][google.api.Service.logging] configurations.
*
*
* repeated .google.api.MonitoredResourceDescriptor monitored_resources = 25;
*/
java.util.List
getMonitoredResourcesList();
/**
*
* Defines the monitored resources used by this service. This is required
* by the [Service.monitoring][google.api.Service.monitoring] and [Service.logging][google.api.Service.logging] configurations.
*
*
* repeated .google.api.MonitoredResourceDescriptor monitored_resources = 25;
*/
com.google.api.MonitoredResourceDescriptor getMonitoredResources(int index);
/**
*
* Defines the monitored resources used by this service. This is required
* by the [Service.monitoring][google.api.Service.monitoring] and [Service.logging][google.api.Service.logging] configurations.
*
*
* repeated .google.api.MonitoredResourceDescriptor monitored_resources = 25;
*/
int getMonitoredResourcesCount();
/**
*
* Defines the monitored resources used by this service. This is required
* by the [Service.monitoring][google.api.Service.monitoring] and [Service.logging][google.api.Service.logging] configurations.
*
*
* repeated .google.api.MonitoredResourceDescriptor monitored_resources = 25;
*/
java.util.List
getMonitoredResourcesOrBuilderList();
/**
*
* Defines the monitored resources used by this service. This is required
* by the [Service.monitoring][google.api.Service.monitoring] and [Service.logging][google.api.Service.logging] configurations.
*
*
* repeated .google.api.MonitoredResourceDescriptor monitored_resources = 25;
*/
com.google.api.MonitoredResourceDescriptorOrBuilder getMonitoredResourcesOrBuilder(
int index);
/**
*
* Billing configuration of the service.
*
*
* optional .google.api.Billing billing = 26;
*/
boolean hasBilling();
/**
*
* Billing configuration of the service.
*
*
* optional .google.api.Billing billing = 26;
*/
com.google.api.Billing getBilling();
/**
*
* Billing configuration of the service.
*
*
* optional .google.api.Billing billing = 26;
*/
com.google.api.BillingOrBuilder getBillingOrBuilder();
/**
*
* Logging configuration of the service.
*
*
* optional .google.api.Logging logging = 27;
*/
boolean hasLogging();
/**
*
* Logging configuration of the service.
*
*
* optional .google.api.Logging logging = 27;
*/
com.google.api.Logging getLogging();
/**
*
* Logging configuration of the service.
*
*
* optional .google.api.Logging logging = 27;
*/
com.google.api.LoggingOrBuilder getLoggingOrBuilder();
/**
*
* Monitoring configuration of the service.
*
*
* optional .google.api.Monitoring monitoring = 28;
*/
boolean hasMonitoring();
/**
*
* Monitoring configuration of the service.
*
*
* optional .google.api.Monitoring monitoring = 28;
*/
com.google.api.Monitoring getMonitoring();
/**
*
* Monitoring configuration of the service.
*
*
* optional .google.api.Monitoring monitoring = 28;
*/
com.google.api.MonitoringOrBuilder getMonitoringOrBuilder();
/**
*
* Configuration for system parameters.
*
*
* optional .google.api.SystemParameters system_parameters = 29;
*/
boolean hasSystemParameters();
/**
*
* Configuration for system parameters.
*
*
* optional .google.api.SystemParameters system_parameters = 29;
*/
com.google.api.SystemParameters getSystemParameters();
/**
*
* Configuration for system parameters.
*
*
* optional .google.api.SystemParameters system_parameters = 29;
*/
com.google.api.SystemParametersOrBuilder getSystemParametersOrBuilder();
}