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 proto-google-common-protos Show documentation
Show all versions of proto-google-common-protos Show documentation
PROTO library for proto-google-common-protos
/*
* Copyright 2024 Google LLC
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* https://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
// Generated by the protocol buffer compiler. DO NOT EDIT!
// source: google/api/service.proto
// Protobuf Java Version: 3.25.4
package com.google.api;
public interface ServiceOrBuilder
extends
// @@protoc_insertion_point(interface_extends:google.api.Service)
com.google.protobuf.MessageOrBuilder {
/**
*
*
*
* 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;
*
* @return The name.
*/
java.lang.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;
*
* @return The bytes for name.
*/
com.google.protobuf.ByteString getNameBytes();
/**
*
*
*
* The product title for this service, it is the name displayed in Google
* Cloud Console.
*
*
* string title = 2;
*
* @return The title.
*/
java.lang.String getTitle();
/**
*
*
*
* The product title for this service, it is the name displayed in Google
* Cloud Console.
*
*
* string title = 2;
*
* @return The bytes for title.
*/
com.google.protobuf.ByteString getTitleBytes();
/**
*
*
*
* The Google project that owns this service.
*
*
* string producer_project_id = 22;
*
* @return The producerProjectId.
*/
java.lang.String getProducerProjectId();
/**
*
*
*
* The Google project that owns this service.
*
*
* string producer_project_id = 22;
*
* @return The bytes for producerProjectId.
*/
com.google.protobuf.ByteString getProducerProjectIdBytes();
/**
*
*
*
* 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;
*
* @return The id.
*/
java.lang.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;
*
* @return The bytes for id.
*/
com.google.protobuf.ByteString getIdBytes();
/**
*
*
*
* 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 by the configuration author. 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 by the configuration author. 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 by the configuration author. 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 by the configuration author. 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 by the configuration author. 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 by the configuration author. 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 by the configuration author. 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 by the configuration author. 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 by the configuration author. 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 by the configuration author. Example:
*
* enums:
* - name: google.someapi.v1.SomeEnum
*
*
* repeated .google.protobuf.Enum enums = 5;
*/
com.google.protobuf.EnumOrBuilder getEnumsOrBuilder(int index);
/**
*
*
*
* Additional API documentation.
*
*
* .google.api.Documentation documentation = 6;
*
* @return Whether the documentation field is set.
*/
boolean hasDocumentation();
/**
*
*
*
* Additional API documentation.
*
*
* .google.api.Documentation documentation = 6;
*
* @return The documentation.
*/
com.google.api.Documentation getDocumentation();
/**
*
*
*
* Additional API documentation.
*
*
* .google.api.Documentation documentation = 6;
*/
com.google.api.DocumentationOrBuilder getDocumentationOrBuilder();
/**
*
*
*
* API backend configuration.
*
*
* .google.api.Backend backend = 8;
*
* @return Whether the backend field is set.
*/
boolean hasBackend();
/**
*
*
*
* API backend configuration.
*
*
* .google.api.Backend backend = 8;
*
* @return The backend.
*/
com.google.api.Backend getBackend();
/**
*
*
*
* API backend configuration.
*
*
* .google.api.Backend backend = 8;
*/
com.google.api.BackendOrBuilder getBackendOrBuilder();
/**
*
*
*
* HTTP configuration.
*
*
* .google.api.Http http = 9;
*
* @return Whether the http field is set.
*/
boolean hasHttp();
/**
*
*
*
* HTTP configuration.
*
*
* .google.api.Http http = 9;
*
* @return The http.
*/
com.google.api.Http getHttp();
/**
*
*
*
* HTTP configuration.
*
*
* .google.api.Http http = 9;
*/
com.google.api.HttpOrBuilder getHttpOrBuilder();
/**
*
*
*
* Quota configuration.
*
*
* .google.api.Quota quota = 10;
*
* @return Whether the quota field is set.
*/
boolean hasQuota();
/**
*
*
*
* Quota configuration.
*
*
* .google.api.Quota quota = 10;
*
* @return The quota.
*/
com.google.api.Quota getQuota();
/**
*
*
*
* Quota configuration.
*
*
* .google.api.Quota quota = 10;
*/
com.google.api.QuotaOrBuilder getQuotaOrBuilder();
/**
*
*
*
* Auth configuration.
*
*
* .google.api.Authentication authentication = 11;
*
* @return Whether the authentication field is set.
*/
boolean hasAuthentication();
/**
*
*
*
* Auth configuration.
*
*
* .google.api.Authentication authentication = 11;
*
* @return The authentication.
*/
com.google.api.Authentication getAuthentication();
/**
*
*
*
* Auth configuration.
*
*
* .google.api.Authentication authentication = 11;
*/
com.google.api.AuthenticationOrBuilder getAuthenticationOrBuilder();
/**
*
*
*
* Context configuration.
*
*
* .google.api.Context context = 12;
*
* @return Whether the context field is set.
*/
boolean hasContext();
/**
*
*
*
* Context configuration.
*
*
* .google.api.Context context = 12;
*
* @return The context.
*/
com.google.api.Context getContext();
/**
*
*
*
* Context configuration.
*
*
* .google.api.Context context = 12;
*/
com.google.api.ContextOrBuilder getContextOrBuilder();
/**
*
*
*
* Configuration controlling usage of this service.
*
*
* .google.api.Usage usage = 15;
*
* @return Whether the usage field is set.
*/
boolean hasUsage();
/**
*
*
*
* Configuration controlling usage of this service.
*
*
* .google.api.Usage usage = 15;
*
* @return The usage.
*/
com.google.api.Usage getUsage();
/**
*
*
*
* Configuration controlling usage of this service.
*
*
* .google.api.Usage usage = 15;
*/
com.google.api.UsageOrBuilder getUsageOrBuilder();
/**
*
*
*
* 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;
*/
java.util.List 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;
*/
com.google.api.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;
*/
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;
*/
java.util.List 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;
*/
com.google.api.EndpointOrBuilder getEndpointsOrBuilder(int index);
/**
*
*
*
* Configuration for the service control plane.
*
*
* .google.api.Control control = 21;
*
* @return Whether the control field is set.
*/
boolean hasControl();
/**
*
*
*
* Configuration for the service control plane.
*
*
* .google.api.Control control = 21;
*
* @return The control.
*/
com.google.api.Control getControl();
/**
*
*
*
* Configuration for the service control plane.
*
*
* .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.
*
*
* .google.api.Billing billing = 26;
*
* @return Whether the billing field is set.
*/
boolean hasBilling();
/**
*
*
*
* Billing configuration.
*
*
* .google.api.Billing billing = 26;
*
* @return The billing.
*/
com.google.api.Billing getBilling();
/**
*
*
*
* Billing configuration.
*
*
* .google.api.Billing billing = 26;
*/
com.google.api.BillingOrBuilder getBillingOrBuilder();
/**
*
*
*
* Logging configuration.
*
*
* .google.api.Logging logging = 27;
*
* @return Whether the logging field is set.
*/
boolean hasLogging();
/**
*
*
*
* Logging configuration.
*
*
* .google.api.Logging logging = 27;
*
* @return The logging.
*/
com.google.api.Logging getLogging();
/**
*
*
*
* Logging configuration.
*
*
* .google.api.Logging logging = 27;
*/
com.google.api.LoggingOrBuilder getLoggingOrBuilder();
/**
*
*
*
* Monitoring configuration.
*
*
* .google.api.Monitoring monitoring = 28;
*
* @return Whether the monitoring field is set.
*/
boolean hasMonitoring();
/**
*
*
*
* Monitoring configuration.
*
*
* .google.api.Monitoring monitoring = 28;
*
* @return The monitoring.
*/
com.google.api.Monitoring getMonitoring();
/**
*
*
*
* Monitoring configuration.
*
*
* .google.api.Monitoring monitoring = 28;
*/
com.google.api.MonitoringOrBuilder getMonitoringOrBuilder();
/**
*
*
*
* System parameter configuration.
*
*
* .google.api.SystemParameters system_parameters = 29;
*
* @return Whether the systemParameters field is set.
*/
boolean hasSystemParameters();
/**
*
*
*
* System parameter configuration.
*
*
* .google.api.SystemParameters system_parameters = 29;
*
* @return The systemParameters.
*/
com.google.api.SystemParameters getSystemParameters();
/**
*
*
*
* System parameter configuration.
*
*
* .google.api.SystemParameters system_parameters = 29;
*/
com.google.api.SystemParametersOrBuilder getSystemParametersOrBuilder();
/**
*
*
*
* Output only. The source information for this configuration if available.
*
*
* .google.api.SourceInfo source_info = 37;
*
* @return Whether the sourceInfo field is set.
*/
boolean hasSourceInfo();
/**
*
*
*
* Output only. The source information for this configuration if available.
*
*
* .google.api.SourceInfo source_info = 37;
*
* @return The sourceInfo.
*/
com.google.api.SourceInfo getSourceInfo();
/**
*
*
*
* Output only. The source information for this configuration if available.
*
*
* .google.api.SourceInfo source_info = 37;
*/
com.google.api.SourceInfoOrBuilder getSourceInfoOrBuilder();
/**
*
*
*
* Settings for [Google Cloud Client
* libraries](https://cloud.google.com/apis/docs/cloud-client-libraries)
* generated from APIs defined as protocol buffers.
*
*
* .google.api.Publishing publishing = 45;
*
* @return Whether the publishing field is set.
*/
boolean hasPublishing();
/**
*
*
*
* Settings for [Google Cloud Client
* libraries](https://cloud.google.com/apis/docs/cloud-client-libraries)
* generated from APIs defined as protocol buffers.
*
*
* .google.api.Publishing publishing = 45;
*
* @return The publishing.
*/
com.google.api.Publishing getPublishing();
/**
*
*
*
* Settings for [Google Cloud Client
* libraries](https://cloud.google.com/apis/docs/cloud-client-libraries)
* generated from APIs defined as protocol buffers.
*
*
* .google.api.Publishing publishing = 45;
*/
com.google.api.PublishingOrBuilder getPublishingOrBuilder();
/**
*
*
*
* 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;
*
* @return Whether the configVersion field is set.
*/
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;
*
* @return The configVersion.
*/
com.google.protobuf.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;
*/
com.google.protobuf.UInt32ValueOrBuilder getConfigVersionOrBuilder();
}