Package com.google.api

Interface ServiceOrBuilder

All Superinterfaces:
com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder
All Known Implementing Classes:
Service, Service.Builder
public interface ServiceOrBuilder extends com.google.protobuf.MessageOrBuilder

  • Method Details

    • getName

      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:
      The name.

    • getNameBytes

      com.google.protobuf.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:
      The bytes for name.

    • getTitle

      String getTitle()
       The product title for this service.
      string title = 2;
      Returns:
      The title.

    • getTitleBytes

      com.google.protobuf.ByteString getTitleBytes()
       The product title for this service.
      string title = 2;
      Returns:
      The bytes for title.

    • getProducerProjectId

      String getProducerProjectId()
       The Google project that owns this service.
      string producer_project_id = 22;
      Returns:
      The producerProjectId.

    • getProducerProjectIdBytes

      com.google.protobuf.ByteString getProducerProjectIdBytes()
       The Google project that owns this service.
      string producer_project_id = 22;
      Returns:
      The bytes for producerProjectId.

    • getId

      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:
      The id.

    • getIdBytes

      com.google.protobuf.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:
      The bytes for id.

    • getApisList

      List<Api> 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;

    • getApis

      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;

    • getApisCount

      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;

    • getApisOrBuilderList

      List<? extends ApiOrBuilder> 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;

    • getApisOrBuilder

      ApiOrBuilder getApisOrBuilder(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;

    • getTypesList

      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;

    • getTypes

      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;

    • getTypesCount

      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;

    • getTypesOrBuilderList

      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;

    • getTypesOrBuilder

      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;

    • getEnumsList

      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;

    • getEnums

      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;

    • getEnumsCount

      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;

    • getEnumsOrBuilderList

      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;

    • getEnumsOrBuilder

      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;

    • hasDocumentation

      boolean hasDocumentation()
       Additional API documentation.
      .google.api.Documentation documentation = 6;
      Returns:
      Whether the documentation field is set.

    • getDocumentation

      Documentation getDocumentation()
       Additional API documentation.
      .google.api.Documentation documentation = 6;
      Returns:
      The documentation.

    • getDocumentationOrBuilder

      DocumentationOrBuilder getDocumentationOrBuilder()
       Additional API documentation.
      .google.api.Documentation documentation = 6;

    • hasBackend

      boolean hasBackend()
       API backend configuration.
      .google.api.Backend backend = 8;
      Returns:
      Whether the backend field is set.

    • getBackend

      Backend getBackend()
       API backend configuration.
      .google.api.Backend backend = 8;
      Returns:
      The backend.

    • getBackendOrBuilder

      BackendOrBuilder getBackendOrBuilder()
       API backend configuration.
      .google.api.Backend backend = 8;

    • hasHttp

      boolean hasHttp()
       HTTP configuration.
      .google.api.Http http = 9;
      Returns:
      Whether the http field is set.

    • getHttp

      Http getHttp()
       HTTP configuration.
      .google.api.Http http = 9;
      Returns:
      The http.

    • getHttpOrBuilder

      HttpOrBuilder getHttpOrBuilder()
       HTTP configuration.
      .google.api.Http http = 9;

    • hasQuota

      boolean hasQuota()
       Quota configuration.
      .google.api.Quota quota = 10;
      Returns:
      Whether the quota field is set.

    • getQuota

      Quota getQuota()
       Quota configuration.
      .google.api.Quota quota = 10;
      Returns:
      The quota.

    • getQuotaOrBuilder

      QuotaOrBuilder getQuotaOrBuilder()
       Quota configuration.
      .google.api.Quota quota = 10;

    • hasAuthentication

      boolean hasAuthentication()
       Auth configuration.
      .google.api.Authentication authentication = 11;
      Returns:
      Whether the authentication field is set.

    • getAuthentication

      Authentication getAuthentication()
       Auth configuration.
      .google.api.Authentication authentication = 11;
      Returns:
      The authentication.

    • getAuthenticationOrBuilder

      AuthenticationOrBuilder getAuthenticationOrBuilder()
       Auth configuration.
      .google.api.Authentication authentication = 11;

    • hasContext

      boolean hasContext()
       Context configuration.
      .google.api.Context context = 12;
      Returns:
      Whether the context field is set.

    • getContext

      Context getContext()
       Context configuration.
      .google.api.Context context = 12;
      Returns:
      The context.

    • getContextOrBuilder

      ContextOrBuilder getContextOrBuilder()
       Context configuration.
      .google.api.Context context = 12;

    • hasUsage

      boolean hasUsage()
       Configuration controlling usage of this service.
      .google.api.Usage usage = 15;
      Returns:
      Whether the usage field is set.

    • getUsage

      Usage getUsage()
       Configuration controlling usage of this service.
      .google.api.Usage usage = 15;
      Returns:
      The usage.

    • getUsageOrBuilder

      UsageOrBuilder getUsageOrBuilder()
       Configuration controlling usage of this service.
      .google.api.Usage usage = 15;

    • getEndpointsList

      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;

    • getEndpoints

      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;

    • getEndpointsCount

      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;

    • getEndpointsOrBuilderList

      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;

    • getEndpointsOrBuilder

      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;

    • hasControl

      boolean hasControl()
       Configuration for the service control plane.
      .google.api.Control control = 21;
      Returns:
      Whether the control field is set.

    • getControl

      Control getControl()
       Configuration for the service control plane.
      .google.api.Control control = 21;
      Returns:
      The control.

    • getControlOrBuilder

      ControlOrBuilder getControlOrBuilder()
       Configuration for the service control plane.
      .google.api.Control control = 21;

    • getLogsList

      List<LogDescriptor> getLogsList()
       Defines the logs used by this service.
      repeated .google.api.LogDescriptor logs = 23;

    • getLogs

      LogDescriptor getLogs(int index)
       Defines the logs used by this service.
      repeated .google.api.LogDescriptor logs = 23;

    • getLogsCount

      int getLogsCount()
       Defines the logs used by this service.
      repeated .google.api.LogDescriptor logs = 23;

    • getLogsOrBuilderList

      List<? extends LogDescriptorOrBuilder> getLogsOrBuilderList()
       Defines the logs used by this service.
      repeated .google.api.LogDescriptor logs = 23;

    • getLogsOrBuilder

      LogDescriptorOrBuilder getLogsOrBuilder(int index)
       Defines the logs used by this service.
      repeated .google.api.LogDescriptor logs = 23;

    • getMetricsList

      List<MetricDescriptor> getMetricsList()
       Defines the metrics used by this service.
      repeated .google.api.MetricDescriptor metrics = 24;

    • getMetrics

      MetricDescriptor getMetrics(int index)
       Defines the metrics used by this service.
      repeated .google.api.MetricDescriptor metrics = 24;

    • getMetricsCount

      int getMetricsCount()
       Defines the metrics used by this service.
      repeated .google.api.MetricDescriptor metrics = 24;

    • getMetricsOrBuilderList

      List<? extends MetricDescriptorOrBuilder> getMetricsOrBuilderList()
       Defines the metrics used by this service.
      repeated .google.api.MetricDescriptor metrics = 24;

    • getMetricsOrBuilder

      MetricDescriptorOrBuilder getMetricsOrBuilder(int index)
       Defines the metrics used by this service.
      repeated .google.api.MetricDescriptor metrics = 24;

    • getMonitoredResourcesList

      List<MonitoredResourceDescriptor> 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;

    • getMonitoredResources

      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;

    • getMonitoredResourcesCount

      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;

    • getMonitoredResourcesOrBuilderList

      List<? extends MonitoredResourceDescriptorOrBuilder> 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;

    • getMonitoredResourcesOrBuilder

      MonitoredResourceDescriptorOrBuilder getMonitoredResourcesOrBuilder(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;

    • hasBilling

      boolean hasBilling()
       Billing configuration.
      .google.api.Billing billing = 26;
      Returns:
      Whether the billing field is set.

    • getBilling

      Billing getBilling()
       Billing configuration.
      .google.api.Billing billing = 26;
      Returns:
      The billing.

    • getBillingOrBuilder

      BillingOrBuilder getBillingOrBuilder()
       Billing configuration.
      .google.api.Billing billing = 26;

    • hasLogging

      boolean hasLogging()
       Logging configuration.
      .google.api.Logging logging = 27;
      Returns:
      Whether the logging field is set.

    • getLogging

      Logging getLogging()
       Logging configuration.
      .google.api.Logging logging = 27;
      Returns:
      The logging.

    • getLoggingOrBuilder

      LoggingOrBuilder getLoggingOrBuilder()
       Logging configuration.
      .google.api.Logging logging = 27;

    • hasMonitoring

      boolean hasMonitoring()
       Monitoring configuration.
      .google.api.Monitoring monitoring = 28;
      Returns:
      Whether the monitoring field is set.

    • getMonitoring

      Monitoring getMonitoring()
       Monitoring configuration.
      .google.api.Monitoring monitoring = 28;
      Returns:
      The monitoring.

    • getMonitoringOrBuilder

      MonitoringOrBuilder getMonitoringOrBuilder()
       Monitoring configuration.
      .google.api.Monitoring monitoring = 28;

    • hasSystemParameters

      boolean hasSystemParameters()
       System parameter configuration.
      .google.api.SystemParameters system_parameters = 29;
      Returns:
      Whether the systemParameters field is set.

    • getSystemParameters

      SystemParameters getSystemParameters()
       System parameter configuration.
      .google.api.SystemParameters system_parameters = 29;
      Returns:
      The systemParameters.

    • getSystemParametersOrBuilder

      SystemParametersOrBuilder getSystemParametersOrBuilder()
       System parameter configuration.
      .google.api.SystemParameters system_parameters = 29;

    • hasSourceInfo

      boolean hasSourceInfo()
       Output only. The source information for this configuration if available.
      .google.api.SourceInfo source_info = 37;
      Returns:
      Whether the sourceInfo field is set.

    • getSourceInfo

      SourceInfo getSourceInfo()
       Output only. The source information for this configuration if available.
      .google.api.SourceInfo source_info = 37;
      Returns:
      The sourceInfo.

    • getSourceInfoOrBuilder

      SourceInfoOrBuilder getSourceInfoOrBuilder()
       Output only. The source information for this configuration if available.
      .google.api.SourceInfo source_info = 37;

    • hasConfigVersion

      @Deprecated boolean hasConfigVersion()
      Deprecated.
       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:
      Whether the configVersion field is set.

    • getConfigVersion

      @Deprecated UInt32Value getConfigVersion()
      Deprecated.
       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:
      The configVersion.

    • getConfigVersionOrBuilder

      @Deprecated UInt32ValueOrBuilder getConfigVersionOrBuilder()
      Deprecated.
       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];