Package com.google.api
Class Service
- java.lang.Object
-
- com.google.protobuf.AbstractMessageLite
-
- com.google.protobuf.AbstractMessage
-
- com.google.protobuf.GeneratedMessageV3
-
- com.google.api.Service
-
- All Implemented Interfaces:
ServiceOrBuilder,com.google.protobuf.Message,com.google.protobuf.MessageLite,com.google.protobuf.MessageLiteOrBuilder,com.google.protobuf.MessageOrBuilder,Serializable
public final class Service extends com.google.protobuf.GeneratedMessageV3 implements ServiceOrBuilder
`Service` is the root object of Google API service configuration (service config). It describes the basic information about a logical service, such as the service name and the user-facing title, and delegates other aspects to sub-sections. Each sub-section is either a proto message or a repeated proto message that configures a specific aspect, such as auth. For more information, see each proto message definition. Example: type: google.api.Service name: calendar.googleapis.com title: Google Calendar API apis: - name: google.calendar.v3.Calendar visibility: rules: - selector: "google.calendar.v3.*" restriction: PREVIEW backend: rules: - selector: "google.calendar.v3.*" address: calendar.example.com authentication: providers: - id: google_calendar_auth jwks_uri: https://www.googleapis.com/oauth2/v1/certs issuer: https://securetoken.google.com rules: - selector: "*" requirements: provider_id: google_calendar_authProtobuf typegoogle.api.Service- See Also:
- Serialized Form
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static classService.Builder`Service` is the root object of Google API service configuration (service config).-
Nested classes/interfaces inherited from class com.google.protobuf.GeneratedMessageV3
com.google.protobuf.GeneratedMessageV3.BuilderParent, com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageType extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage,BuilderType extends com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageType,BuilderType>>, com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageType extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage>, com.google.protobuf.GeneratedMessageV3.ExtendableMessageOrBuilder<MessageType extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage>, com.google.protobuf.GeneratedMessageV3.FieldAccessorTable, com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter
-
-
Field Summary
Fields Modifier and Type Field Description static intAPIS_FIELD_NUMBERstatic intAUTHENTICATION_FIELD_NUMBERstatic intBACKEND_FIELD_NUMBERstatic intBILLING_FIELD_NUMBERstatic intCONFIG_VERSION_FIELD_NUMBERstatic intCONTEXT_FIELD_NUMBERstatic intCONTROL_FIELD_NUMBERstatic intDOCUMENTATION_FIELD_NUMBERstatic intENDPOINTS_FIELD_NUMBERstatic intENUMS_FIELD_NUMBERstatic intHTTP_FIELD_NUMBERstatic intID_FIELD_NUMBERstatic intLOGGING_FIELD_NUMBERstatic intLOGS_FIELD_NUMBERstatic intMETRICS_FIELD_NUMBERstatic intMONITORED_RESOURCES_FIELD_NUMBERstatic intMONITORING_FIELD_NUMBERstatic intNAME_FIELD_NUMBERstatic intPRODUCER_PROJECT_ID_FIELD_NUMBERstatic intPUBLISHING_FIELD_NUMBERstatic intQUOTA_FIELD_NUMBERstatic intSOURCE_INFO_FIELD_NUMBERstatic intSYSTEM_PARAMETERS_FIELD_NUMBERstatic intTITLE_FIELD_NUMBERstatic intTYPES_FIELD_NUMBERstatic intUSAGE_FIELD_NUMBER
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description booleanequals(Object obj)com.google.protobuf.ApigetApis(int index)A list of API interfaces exported by this service.intgetApisCount()A list of API interfaces exported by this service.List<com.google.protobuf.Api>getApisList()A list of API interfaces exported by this service.com.google.protobuf.ApiOrBuildergetApisOrBuilder(int index)A list of API interfaces exported by this service.List<? extends com.google.protobuf.ApiOrBuilder>getApisOrBuilderList()A list of API interfaces exported by this service.AuthenticationgetAuthentication()Auth configuration.AuthenticationOrBuildergetAuthenticationOrBuilder()Auth configuration.BackendgetBackend()API backend configuration.BackendOrBuildergetBackendOrBuilder()API backend configuration.BillinggetBilling()Billing configuration.BillingOrBuildergetBillingOrBuilder()Billing configuration.com.google.protobuf.UInt32ValuegetConfigVersion()Obsolete.com.google.protobuf.UInt32ValueOrBuildergetConfigVersionOrBuilder()Obsolete.ContextgetContext()Context configuration.ContextOrBuildergetContextOrBuilder()Context configuration.ControlgetControl()Configuration for the service control plane.ControlOrBuildergetControlOrBuilder()Configuration for the service control plane.static ServicegetDefaultInstance()ServicegetDefaultInstanceForType()static com.google.protobuf.Descriptors.DescriptorgetDescriptor()DocumentationgetDocumentation()Additional API documentation.DocumentationOrBuildergetDocumentationOrBuilder()Additional API documentation.EndpointgetEndpoints(int index)Configuration for network endpoints.intgetEndpointsCount()Configuration for network endpoints.List<Endpoint>getEndpointsList()Configuration for network endpoints.EndpointOrBuildergetEndpointsOrBuilder(int index)Configuration for network endpoints.List<? extends EndpointOrBuilder>getEndpointsOrBuilderList()Configuration for network endpoints.com.google.protobuf.EnumgetEnums(int index)A list of all enum types included in this API service.intgetEnumsCount()A list of all enum types included in this API service.List<com.google.protobuf.Enum>getEnumsList()A list of all enum types included in this API service.com.google.protobuf.EnumOrBuildergetEnumsOrBuilder(int index)A list of all enum types included in this API service.List<? extends com.google.protobuf.EnumOrBuilder>getEnumsOrBuilderList()A list of all enum types included in this API service.HttpgetHttp()HTTP configuration.HttpOrBuildergetHttpOrBuilder()HTTP configuration.StringgetId()A unique ID for a specific instance of this message, typically assigned by the client for tracking purpose.com.google.protobuf.ByteStringgetIdBytes()A unique ID for a specific instance of this message, typically assigned by the client for tracking purpose.LogginggetLogging()Logging configuration.LoggingOrBuildergetLoggingOrBuilder()Logging configuration.LogDescriptorgetLogs(int index)Defines the logs used by this service.intgetLogsCount()Defines the logs used by this service.List<LogDescriptor>getLogsList()Defines the logs used by this service.LogDescriptorOrBuildergetLogsOrBuilder(int index)Defines the logs used by this service.List<? extends LogDescriptorOrBuilder>getLogsOrBuilderList()Defines the logs used by this service.MetricDescriptorgetMetrics(int index)Defines the metrics used by this service.intgetMetricsCount()Defines the metrics used by this service.List<MetricDescriptor>getMetricsList()Defines the metrics used by this service.MetricDescriptorOrBuildergetMetricsOrBuilder(int index)Defines the metrics used by this service.List<? extends MetricDescriptorOrBuilder>getMetricsOrBuilderList()Defines the metrics used by this service.MonitoredResourceDescriptorgetMonitoredResources(int index)Defines the monitored resources used by this service.intgetMonitoredResourcesCount()Defines the monitored resources used by this service.List<MonitoredResourceDescriptor>getMonitoredResourcesList()Defines the monitored resources used by this service.MonitoredResourceDescriptorOrBuildergetMonitoredResourcesOrBuilder(int index)Defines the monitored resources used by this service.List<? extends MonitoredResourceDescriptorOrBuilder>getMonitoredResourcesOrBuilderList()Defines the monitored resources used by this service.MonitoringgetMonitoring()Monitoring configuration.MonitoringOrBuildergetMonitoringOrBuilder()Monitoring configuration.StringgetName()The service name, which is a DNS-like logical identifier for the service, such as `calendar.googleapis.com`.com.google.protobuf.ByteStringgetNameBytes()The service name, which is a DNS-like logical identifier for the service, such as `calendar.googleapis.com`.com.google.protobuf.Parser<Service>getParserForType()StringgetProducerProjectId()The Google project that owns this service.com.google.protobuf.ByteStringgetProducerProjectIdBytes()The Google project that owns this service.PublishinggetPublishing()Settings for [Google Cloud Client libraries](https://cloud.google.com/apis/docs/cloud-client-libraries) generated from APIs defined as protocol buffers.PublishingOrBuildergetPublishingOrBuilder()Settings for [Google Cloud Client libraries](https://cloud.google.com/apis/docs/cloud-client-libraries) generated from APIs defined as protocol buffers.QuotagetQuota()Quota configuration.QuotaOrBuildergetQuotaOrBuilder()Quota configuration.intgetSerializedSize()SourceInfogetSourceInfo()Output only.SourceInfoOrBuildergetSourceInfoOrBuilder()Output only.SystemParametersgetSystemParameters()System parameter configuration.SystemParametersOrBuildergetSystemParametersOrBuilder()System parameter configuration.StringgetTitle()The product title for this service, it is the name displayed in Google Cloud Console.com.google.protobuf.ByteStringgetTitleBytes()The product title for this service, it is the name displayed in Google Cloud Console.com.google.protobuf.TypegetTypes(int index)A list of all proto message types included in this API service.intgetTypesCount()A list of all proto message types included in this API service.List<com.google.protobuf.Type>getTypesList()A list of all proto message types included in this API service.com.google.protobuf.TypeOrBuildergetTypesOrBuilder(int index)A list of all proto message types included in this API service.List<? extends com.google.protobuf.TypeOrBuilder>getTypesOrBuilderList()A list of all proto message types included in this API service.com.google.protobuf.UnknownFieldSetgetUnknownFields()UsagegetUsage()Configuration controlling usage of this service.UsageOrBuildergetUsageOrBuilder()Configuration controlling usage of this service.booleanhasAuthentication()Auth configuration.booleanhasBackend()API backend configuration.booleanhasBilling()Billing configuration.booleanhasConfigVersion()Obsolete.booleanhasContext()Context configuration.booleanhasControl()Configuration for the service control plane.booleanhasDocumentation()Additional API documentation.inthashCode()booleanhasHttp()HTTP configuration.booleanhasLogging()Logging configuration.booleanhasMonitoring()Monitoring configuration.booleanhasPublishing()Settings for [Google Cloud Client libraries](https://cloud.google.com/apis/docs/cloud-client-libraries) generated from APIs defined as protocol buffers.booleanhasQuota()Quota configuration.booleanhasSourceInfo()Output only.booleanhasSystemParameters()System parameter configuration.booleanhasUsage()Configuration controlling usage of this service.protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTableinternalGetFieldAccessorTable()booleanisInitialized()static Service.BuildernewBuilder()static Service.BuildernewBuilder(Service prototype)Service.BuildernewBuilderForType()protected Service.BuildernewBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)protected ObjectnewInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)static ServiceparseDelimitedFrom(InputStream input)static ServiceparseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)static ServiceparseFrom(byte[] data)static ServiceparseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)static ServiceparseFrom(com.google.protobuf.ByteString data)static ServiceparseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)static ServiceparseFrom(com.google.protobuf.CodedInputStream input)static ServiceparseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)static ServiceparseFrom(InputStream input)static ServiceparseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)static ServiceparseFrom(ByteBuffer data)static ServiceparseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)static com.google.protobuf.Parser<Service>parser()Service.BuildertoBuilder()voidwriteTo(com.google.protobuf.CodedOutputStream output)-
Methods inherited from class com.google.protobuf.GeneratedMessageV3
canUseUnsafe, computeStringSize, computeStringSizeNoTag, emptyBooleanList, emptyDoubleList, emptyFloatList, emptyIntList, emptyLongList, getAllFields, getDescriptorForType, getField, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, hasField, hasOneof, internalGetMapField, isStringEmpty, makeExtensionsImmutable, mergeFromAndMakeImmutableInternal, mutableCopy, mutableCopy, mutableCopy, mutableCopy, mutableCopy, newBooleanList, newBuilderForType, newDoubleList, newFloatList, newIntList, newLongList, parseDelimitedWithIOException, parseDelimitedWithIOException, parseUnknownField, parseUnknownFieldProto3, parseWithIOException, parseWithIOException, parseWithIOException, parseWithIOException, serializeBooleanMapTo, serializeIntegerMapTo, serializeLongMapTo, serializeStringMapTo, writeReplace, writeString, writeStringNoTag
-
Methods inherited from class com.google.protobuf.AbstractMessage
findInitializationErrors, getInitializationErrorString, hashBoolean, hashEnum, hashEnumList, hashFields, hashLong, toString
-
Methods inherited from class com.google.protobuf.AbstractMessageLite
addAll, addAll, checkByteStringIsUtf8, toByteArray, toByteString, writeDelimitedTo, writeTo
-
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
-
-
-
-
Field Detail
-
NAME_FIELD_NUMBER
public static final int NAME_FIELD_NUMBER
- See Also:
- Constant Field Values
-
TITLE_FIELD_NUMBER
public static final int TITLE_FIELD_NUMBER
- See Also:
- Constant Field Values
-
PRODUCER_PROJECT_ID_FIELD_NUMBER
public static final int PRODUCER_PROJECT_ID_FIELD_NUMBER
- See Also:
- Constant Field Values
-
ID_FIELD_NUMBER
public static final int ID_FIELD_NUMBER
- See Also:
- Constant Field Values
-
APIS_FIELD_NUMBER
public static final int APIS_FIELD_NUMBER
- See Also:
- Constant Field Values
-
TYPES_FIELD_NUMBER
public static final int TYPES_FIELD_NUMBER
- See Also:
- Constant Field Values
-
ENUMS_FIELD_NUMBER
public static final int ENUMS_FIELD_NUMBER
- See Also:
- Constant Field Values
-
DOCUMENTATION_FIELD_NUMBER
public static final int DOCUMENTATION_FIELD_NUMBER
- See Also:
- Constant Field Values
-
BACKEND_FIELD_NUMBER
public static final int BACKEND_FIELD_NUMBER
- See Also:
- Constant Field Values
-
HTTP_FIELD_NUMBER
public static final int HTTP_FIELD_NUMBER
- See Also:
- Constant Field Values
-
QUOTA_FIELD_NUMBER
public static final int QUOTA_FIELD_NUMBER
- See Also:
- Constant Field Values
-
AUTHENTICATION_FIELD_NUMBER
public static final int AUTHENTICATION_FIELD_NUMBER
- See Also:
- Constant Field Values
-
CONTEXT_FIELD_NUMBER
public static final int CONTEXT_FIELD_NUMBER
- See Also:
- Constant Field Values
-
USAGE_FIELD_NUMBER
public static final int USAGE_FIELD_NUMBER
- See Also:
- Constant Field Values
-
ENDPOINTS_FIELD_NUMBER
public static final int ENDPOINTS_FIELD_NUMBER
- See Also:
- Constant Field Values
-
CONTROL_FIELD_NUMBER
public static final int CONTROL_FIELD_NUMBER
- See Also:
- Constant Field Values
-
LOGS_FIELD_NUMBER
public static final int LOGS_FIELD_NUMBER
- See Also:
- Constant Field Values
-
METRICS_FIELD_NUMBER
public static final int METRICS_FIELD_NUMBER
- See Also:
- Constant Field Values
-
MONITORED_RESOURCES_FIELD_NUMBER
public static final int MONITORED_RESOURCES_FIELD_NUMBER
- See Also:
- Constant Field Values
-
BILLING_FIELD_NUMBER
public static final int BILLING_FIELD_NUMBER
- See Also:
- Constant Field Values
-
LOGGING_FIELD_NUMBER
public static final int LOGGING_FIELD_NUMBER
- See Also:
- Constant Field Values
-
MONITORING_FIELD_NUMBER
public static final int MONITORING_FIELD_NUMBER
- See Also:
- Constant Field Values
-
SYSTEM_PARAMETERS_FIELD_NUMBER
public static final int SYSTEM_PARAMETERS_FIELD_NUMBER
- See Also:
- Constant Field Values
-
SOURCE_INFO_FIELD_NUMBER
public static final int SOURCE_INFO_FIELD_NUMBER
- See Also:
- Constant Field Values
-
PUBLISHING_FIELD_NUMBER
public static final int PUBLISHING_FIELD_NUMBER
- See Also:
- Constant Field Values
-
CONFIG_VERSION_FIELD_NUMBER
public static final int CONFIG_VERSION_FIELD_NUMBER
- See Also:
- Constant Field Values
-
-
Method Detail
-
newInstance
protected Object newInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)
- Overrides:
newInstancein classcom.google.protobuf.GeneratedMessageV3
-
getUnknownFields
public final com.google.protobuf.UnknownFieldSet getUnknownFields()
- Specified by:
getUnknownFieldsin interfacecom.google.protobuf.MessageOrBuilder- Overrides:
getUnknownFieldsin classcom.google.protobuf.GeneratedMessageV3
-
getDescriptor
public static final com.google.protobuf.Descriptors.Descriptor getDescriptor()
-
internalGetFieldAccessorTable
protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
- Specified by:
internalGetFieldAccessorTablein classcom.google.protobuf.GeneratedMessageV3
-
getName
public 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;- Specified by:
getNamein interfaceServiceOrBuilder- Returns:
- The name.
-
getNameBytes
public 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;- Specified by:
getNameBytesin interfaceServiceOrBuilder- Returns:
- The bytes for name.
-
getTitle
public String getTitle()
The product title for this service, it is the name displayed in Google Cloud Console.
string title = 2;- Specified by:
getTitlein interfaceServiceOrBuilder- Returns:
- The title.
-
getTitleBytes
public com.google.protobuf.ByteString getTitleBytes()
The product title for this service, it is the name displayed in Google Cloud Console.
string title = 2;- Specified by:
getTitleBytesin interfaceServiceOrBuilder- Returns:
- The bytes for title.
-
getProducerProjectId
public String getProducerProjectId()
The Google project that owns this service.
string producer_project_id = 22;- Specified by:
getProducerProjectIdin interfaceServiceOrBuilder- Returns:
- The producerProjectId.
-
getProducerProjectIdBytes
public com.google.protobuf.ByteString getProducerProjectIdBytes()
The Google project that owns this service.
string producer_project_id = 22;- Specified by:
getProducerProjectIdBytesin interfaceServiceOrBuilder- Returns:
- The bytes for producerProjectId.
-
getId
public 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;- Specified by:
getIdin interfaceServiceOrBuilder- Returns:
- The id.
-
getIdBytes
public 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;- Specified by:
getIdBytesin interfaceServiceOrBuilder- Returns:
- The bytes for id.
-
getApisList
public List<com.google.protobuf.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;- Specified by:
getApisListin interfaceServiceOrBuilder
-
getApisOrBuilderList
public List<? extends com.google.protobuf.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;- Specified by:
getApisOrBuilderListin interfaceServiceOrBuilder
-
getApisCount
public 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;- Specified by:
getApisCountin interfaceServiceOrBuilder
-
getApis
public 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;- Specified by:
getApisin interfaceServiceOrBuilder
-
getApisOrBuilder
public com.google.protobuf.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;- Specified by:
getApisOrBuilderin interfaceServiceOrBuilder
-
getTypesList
public List<com.google.protobuf.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.Int32repeated .google.protobuf.Type types = 4;- Specified by:
getTypesListin interfaceServiceOrBuilder
-
getTypesOrBuilderList
public List<? extends com.google.protobuf.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.Int32repeated .google.protobuf.Type types = 4;- Specified by:
getTypesOrBuilderListin interfaceServiceOrBuilder
-
getTypesCount
public 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.Int32repeated .google.protobuf.Type types = 4;- Specified by:
getTypesCountin interfaceServiceOrBuilder
-
getTypes
public 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.Int32repeated .google.protobuf.Type types = 4;- Specified by:
getTypesin interfaceServiceOrBuilder
-
getTypesOrBuilder
public com.google.protobuf.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.Int32repeated .google.protobuf.Type types = 4;- Specified by:
getTypesOrBuilderin interfaceServiceOrBuilder
-
getEnumsList
public List<com.google.protobuf.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.SomeEnumrepeated .google.protobuf.Enum enums = 5;- Specified by:
getEnumsListin interfaceServiceOrBuilder
-
getEnumsOrBuilderList
public List<? extends com.google.protobuf.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.SomeEnumrepeated .google.protobuf.Enum enums = 5;- Specified by:
getEnumsOrBuilderListin interfaceServiceOrBuilder
-
getEnumsCount
public 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.SomeEnumrepeated .google.protobuf.Enum enums = 5;- Specified by:
getEnumsCountin interfaceServiceOrBuilder
-
getEnums
public 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.SomeEnumrepeated .google.protobuf.Enum enums = 5;- Specified by:
getEnumsin interfaceServiceOrBuilder
-
getEnumsOrBuilder
public com.google.protobuf.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.SomeEnumrepeated .google.protobuf.Enum enums = 5;- Specified by:
getEnumsOrBuilderin interfaceServiceOrBuilder
-
hasDocumentation
public boolean hasDocumentation()
Additional API documentation.
.google.api.Documentation documentation = 6;- Specified by:
hasDocumentationin interfaceServiceOrBuilder- Returns:
- Whether the documentation field is set.
-
getDocumentation
public Documentation getDocumentation()
Additional API documentation.
.google.api.Documentation documentation = 6;- Specified by:
getDocumentationin interfaceServiceOrBuilder- Returns:
- The documentation.
-
getDocumentationOrBuilder
public DocumentationOrBuilder getDocumentationOrBuilder()
Additional API documentation.
.google.api.Documentation documentation = 6;- Specified by:
getDocumentationOrBuilderin interfaceServiceOrBuilder
-
hasBackend
public boolean hasBackend()
API backend configuration.
.google.api.Backend backend = 8;- Specified by:
hasBackendin interfaceServiceOrBuilder- Returns:
- Whether the backend field is set.
-
getBackend
public Backend getBackend()
API backend configuration.
.google.api.Backend backend = 8;- Specified by:
getBackendin interfaceServiceOrBuilder- Returns:
- The backend.
-
getBackendOrBuilder
public BackendOrBuilder getBackendOrBuilder()
API backend configuration.
.google.api.Backend backend = 8;- Specified by:
getBackendOrBuilderin interfaceServiceOrBuilder
-
hasHttp
public boolean hasHttp()
HTTP configuration.
.google.api.Http http = 9;- Specified by:
hasHttpin interfaceServiceOrBuilder- Returns:
- Whether the http field is set.
-
getHttp
public Http getHttp()
HTTP configuration.
.google.api.Http http = 9;- Specified by:
getHttpin interfaceServiceOrBuilder- Returns:
- The http.
-
getHttpOrBuilder
public HttpOrBuilder getHttpOrBuilder()
HTTP configuration.
.google.api.Http http = 9;- Specified by:
getHttpOrBuilderin interfaceServiceOrBuilder
-
hasQuota
public boolean hasQuota()
Quota configuration.
.google.api.Quota quota = 10;- Specified by:
hasQuotain interfaceServiceOrBuilder- Returns:
- Whether the quota field is set.
-
getQuota
public Quota getQuota()
Quota configuration.
.google.api.Quota quota = 10;- Specified by:
getQuotain interfaceServiceOrBuilder- Returns:
- The quota.
-
getQuotaOrBuilder
public QuotaOrBuilder getQuotaOrBuilder()
Quota configuration.
.google.api.Quota quota = 10;- Specified by:
getQuotaOrBuilderin interfaceServiceOrBuilder
-
hasAuthentication
public boolean hasAuthentication()
Auth configuration.
.google.api.Authentication authentication = 11;- Specified by:
hasAuthenticationin interfaceServiceOrBuilder- Returns:
- Whether the authentication field is set.
-
getAuthentication
public Authentication getAuthentication()
Auth configuration.
.google.api.Authentication authentication = 11;- Specified by:
getAuthenticationin interfaceServiceOrBuilder- Returns:
- The authentication.
-
getAuthenticationOrBuilder
public AuthenticationOrBuilder getAuthenticationOrBuilder()
Auth configuration.
.google.api.Authentication authentication = 11;- Specified by:
getAuthenticationOrBuilderin interfaceServiceOrBuilder
-
hasContext
public boolean hasContext()
Context configuration.
.google.api.Context context = 12;- Specified by:
hasContextin interfaceServiceOrBuilder- Returns:
- Whether the context field is set.
-
getContext
public Context getContext()
Context configuration.
.google.api.Context context = 12;- Specified by:
getContextin interfaceServiceOrBuilder- Returns:
- The context.
-
getContextOrBuilder
public ContextOrBuilder getContextOrBuilder()
Context configuration.
.google.api.Context context = 12;- Specified by:
getContextOrBuilderin interfaceServiceOrBuilder
-
hasUsage
public boolean hasUsage()
Configuration controlling usage of this service.
.google.api.Usage usage = 15;- Specified by:
hasUsagein interfaceServiceOrBuilder- Returns:
- Whether the usage field is set.
-
getUsage
public Usage getUsage()
Configuration controlling usage of this service.
.google.api.Usage usage = 15;- Specified by:
getUsagein interfaceServiceOrBuilder- Returns:
- The usage.
-
getUsageOrBuilder
public UsageOrBuilder getUsageOrBuilder()
Configuration controlling usage of this service.
.google.api.Usage usage = 15;- Specified by:
getUsageOrBuilderin interfaceServiceOrBuilder
-
getEndpointsList
public 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;- Specified by:
getEndpointsListin interfaceServiceOrBuilder
-
getEndpointsOrBuilderList
public 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;- Specified by:
getEndpointsOrBuilderListin interfaceServiceOrBuilder
-
getEndpointsCount
public 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;- Specified by:
getEndpointsCountin interfaceServiceOrBuilder
-
getEndpoints
public 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;- Specified by:
getEndpointsin interfaceServiceOrBuilder
-
getEndpointsOrBuilder
public 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;- Specified by:
getEndpointsOrBuilderin interfaceServiceOrBuilder
-
hasControl
public boolean hasControl()
Configuration for the service control plane.
.google.api.Control control = 21;- Specified by:
hasControlin interfaceServiceOrBuilder- Returns:
- Whether the control field is set.
-
getControl
public Control getControl()
Configuration for the service control plane.
.google.api.Control control = 21;- Specified by:
getControlin interfaceServiceOrBuilder- Returns:
- The control.
-
getControlOrBuilder
public ControlOrBuilder getControlOrBuilder()
Configuration for the service control plane.
.google.api.Control control = 21;- Specified by:
getControlOrBuilderin interfaceServiceOrBuilder
-
getLogsList
public List<LogDescriptor> getLogsList()
Defines the logs used by this service.
repeated .google.api.LogDescriptor logs = 23;- Specified by:
getLogsListin interfaceServiceOrBuilder
-
getLogsOrBuilderList
public List<? extends LogDescriptorOrBuilder> getLogsOrBuilderList()
Defines the logs used by this service.
repeated .google.api.LogDescriptor logs = 23;- Specified by:
getLogsOrBuilderListin interfaceServiceOrBuilder
-
getLogsCount
public int getLogsCount()
Defines the logs used by this service.
repeated .google.api.LogDescriptor logs = 23;- Specified by:
getLogsCountin interfaceServiceOrBuilder
-
getLogs
public LogDescriptor getLogs(int index)
Defines the logs used by this service.
repeated .google.api.LogDescriptor logs = 23;- Specified by:
getLogsin interfaceServiceOrBuilder
-
getLogsOrBuilder
public LogDescriptorOrBuilder getLogsOrBuilder(int index)
Defines the logs used by this service.
repeated .google.api.LogDescriptor logs = 23;- Specified by:
getLogsOrBuilderin interfaceServiceOrBuilder
-
getMetricsList
public List<MetricDescriptor> getMetricsList()
Defines the metrics used by this service.
repeated .google.api.MetricDescriptor metrics = 24;- Specified by:
getMetricsListin interfaceServiceOrBuilder
-
getMetricsOrBuilderList
public List<? extends MetricDescriptorOrBuilder> getMetricsOrBuilderList()
Defines the metrics used by this service.
repeated .google.api.MetricDescriptor metrics = 24;- Specified by:
getMetricsOrBuilderListin interfaceServiceOrBuilder
-
getMetricsCount
public int getMetricsCount()
Defines the metrics used by this service.
repeated .google.api.MetricDescriptor metrics = 24;- Specified by:
getMetricsCountin interfaceServiceOrBuilder
-
getMetrics
public MetricDescriptor getMetrics(int index)
Defines the metrics used by this service.
repeated .google.api.MetricDescriptor metrics = 24;- Specified by:
getMetricsin interfaceServiceOrBuilder
-
getMetricsOrBuilder
public MetricDescriptorOrBuilder getMetricsOrBuilder(int index)
Defines the metrics used by this service.
repeated .google.api.MetricDescriptor metrics = 24;- Specified by:
getMetricsOrBuilderin interfaceServiceOrBuilder
-
getMonitoredResourcesList
public 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;- Specified by:
getMonitoredResourcesListin interfaceServiceOrBuilder
-
getMonitoredResourcesOrBuilderList
public 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;- Specified by:
getMonitoredResourcesOrBuilderListin interfaceServiceOrBuilder
-
getMonitoredResourcesCount
public 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;- Specified by:
getMonitoredResourcesCountin interfaceServiceOrBuilder
-
getMonitoredResources
public 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;- Specified by:
getMonitoredResourcesin interfaceServiceOrBuilder
-
getMonitoredResourcesOrBuilder
public 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;- Specified by:
getMonitoredResourcesOrBuilderin interfaceServiceOrBuilder
-
hasBilling
public boolean hasBilling()
Billing configuration.
.google.api.Billing billing = 26;- Specified by:
hasBillingin interfaceServiceOrBuilder- Returns:
- Whether the billing field is set.
-
getBilling
public Billing getBilling()
Billing configuration.
.google.api.Billing billing = 26;- Specified by:
getBillingin interfaceServiceOrBuilder- Returns:
- The billing.
-
getBillingOrBuilder
public BillingOrBuilder getBillingOrBuilder()
Billing configuration.
.google.api.Billing billing = 26;- Specified by:
getBillingOrBuilderin interfaceServiceOrBuilder
-
hasLogging
public boolean hasLogging()
Logging configuration.
.google.api.Logging logging = 27;- Specified by:
hasLoggingin interfaceServiceOrBuilder- Returns:
- Whether the logging field is set.
-
getLogging
public Logging getLogging()
Logging configuration.
.google.api.Logging logging = 27;- Specified by:
getLoggingin interfaceServiceOrBuilder- Returns:
- The logging.
-
getLoggingOrBuilder
public LoggingOrBuilder getLoggingOrBuilder()
Logging configuration.
.google.api.Logging logging = 27;- Specified by:
getLoggingOrBuilderin interfaceServiceOrBuilder
-
hasMonitoring
public boolean hasMonitoring()
Monitoring configuration.
.google.api.Monitoring monitoring = 28;- Specified by:
hasMonitoringin interfaceServiceOrBuilder- Returns:
- Whether the monitoring field is set.
-
getMonitoring
public Monitoring getMonitoring()
Monitoring configuration.
.google.api.Monitoring monitoring = 28;- Specified by:
getMonitoringin interfaceServiceOrBuilder- Returns:
- The monitoring.
-
getMonitoringOrBuilder
public MonitoringOrBuilder getMonitoringOrBuilder()
Monitoring configuration.
.google.api.Monitoring monitoring = 28;- Specified by:
getMonitoringOrBuilderin interfaceServiceOrBuilder
-
hasSystemParameters
public boolean hasSystemParameters()
System parameter configuration.
.google.api.SystemParameters system_parameters = 29;- Specified by:
hasSystemParametersin interfaceServiceOrBuilder- Returns:
- Whether the systemParameters field is set.
-
getSystemParameters
public SystemParameters getSystemParameters()
System parameter configuration.
.google.api.SystemParameters system_parameters = 29;- Specified by:
getSystemParametersin interfaceServiceOrBuilder- Returns:
- The systemParameters.
-
getSystemParametersOrBuilder
public SystemParametersOrBuilder getSystemParametersOrBuilder()
System parameter configuration.
.google.api.SystemParameters system_parameters = 29;- Specified by:
getSystemParametersOrBuilderin interfaceServiceOrBuilder
-
hasSourceInfo
public boolean hasSourceInfo()
Output only. The source information for this configuration if available.
.google.api.SourceInfo source_info = 37;- Specified by:
hasSourceInfoin interfaceServiceOrBuilder- Returns:
- Whether the sourceInfo field is set.
-
getSourceInfo
public SourceInfo getSourceInfo()
Output only. The source information for this configuration if available.
.google.api.SourceInfo source_info = 37;- Specified by:
getSourceInfoin interfaceServiceOrBuilder- Returns:
- The sourceInfo.
-
getSourceInfoOrBuilder
public SourceInfoOrBuilder getSourceInfoOrBuilder()
Output only. The source information for this configuration if available.
.google.api.SourceInfo source_info = 37;- Specified by:
getSourceInfoOrBuilderin interfaceServiceOrBuilder
-
hasPublishing
public 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;- Specified by:
hasPublishingin interfaceServiceOrBuilder- Returns:
- Whether the publishing field is set.
-
getPublishing
public 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;- Specified by:
getPublishingin interfaceServiceOrBuilder- Returns:
- The publishing.
-
getPublishingOrBuilder
public PublishingOrBuilder getPublishingOrBuilder()
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;- Specified by:
getPublishingOrBuilderin interfaceServiceOrBuilder
-
hasConfigVersion
public 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;- Specified by:
hasConfigVersionin interfaceServiceOrBuilder- Returns:
- Whether the configVersion field is set.
-
getConfigVersion
public 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;- Specified by:
getConfigVersionin interfaceServiceOrBuilder- Returns:
- The configVersion.
-
getConfigVersionOrBuilder
public com.google.protobuf.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;- Specified by:
getConfigVersionOrBuilderin interfaceServiceOrBuilder
-
isInitialized
public final boolean isInitialized()
- Specified by:
isInitializedin interfacecom.google.protobuf.MessageLiteOrBuilder- Overrides:
isInitializedin classcom.google.protobuf.GeneratedMessageV3
-
writeTo
public void writeTo(com.google.protobuf.CodedOutputStream output) throws IOException- Specified by:
writeToin interfacecom.google.protobuf.MessageLite- Overrides:
writeToin classcom.google.protobuf.GeneratedMessageV3- Throws:
IOException
-
getSerializedSize
public int getSerializedSize()
- Specified by:
getSerializedSizein interfacecom.google.protobuf.MessageLite- Overrides:
getSerializedSizein classcom.google.protobuf.GeneratedMessageV3
-
equals
public boolean equals(Object obj)
- Specified by:
equalsin interfacecom.google.protobuf.Message- Overrides:
equalsin classcom.google.protobuf.AbstractMessage
-
hashCode
public int hashCode()
- Specified by:
hashCodein interfacecom.google.protobuf.Message- Overrides:
hashCodein classcom.google.protobuf.AbstractMessage
-
parseFrom
public static Service parseFrom(ByteBuffer data) throws com.google.protobuf.InvalidProtocolBufferException
- Throws:
com.google.protobuf.InvalidProtocolBufferException
-
parseFrom
public static Service parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
- Throws:
com.google.protobuf.InvalidProtocolBufferException
-
parseFrom
public static Service parseFrom(com.google.protobuf.ByteString data) throws com.google.protobuf.InvalidProtocolBufferException
- Throws:
com.google.protobuf.InvalidProtocolBufferException
-
parseFrom
public static Service parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
- Throws:
com.google.protobuf.InvalidProtocolBufferException
-
parseFrom
public static Service parseFrom(byte[] data) throws com.google.protobuf.InvalidProtocolBufferException
- Throws:
com.google.protobuf.InvalidProtocolBufferException
-
parseFrom
public static Service parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
- Throws:
com.google.protobuf.InvalidProtocolBufferException
-
parseFrom
public static Service parseFrom(InputStream input) throws IOException
- Throws:
IOException
-
parseFrom
public static Service parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
- Throws:
IOException
-
parseDelimitedFrom
public static Service parseDelimitedFrom(InputStream input) throws IOException
- Throws:
IOException
-
parseDelimitedFrom
public static Service parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
- Throws:
IOException
-
parseFrom
public static Service parseFrom(com.google.protobuf.CodedInputStream input) throws IOException
- Throws:
IOException
-
parseFrom
public static Service parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
- Throws:
IOException
-
newBuilderForType
public Service.Builder newBuilderForType()
- Specified by:
newBuilderForTypein interfacecom.google.protobuf.Message- Specified by:
newBuilderForTypein interfacecom.google.protobuf.MessageLite
-
newBuilder
public static Service.Builder newBuilder()
-
newBuilder
public static Service.Builder newBuilder(Service prototype)
-
toBuilder
public Service.Builder toBuilder()
- Specified by:
toBuilderin interfacecom.google.protobuf.Message- Specified by:
toBuilderin interfacecom.google.protobuf.MessageLite
-
newBuilderForType
protected Service.Builder newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
- Specified by:
newBuilderForTypein classcom.google.protobuf.GeneratedMessageV3
-
getDefaultInstance
public static Service getDefaultInstance()
-
parser
public static com.google.protobuf.Parser<Service> parser()
-
getParserForType
public com.google.protobuf.Parser<Service> getParserForType()
- Specified by:
getParserForTypein interfacecom.google.protobuf.Message- Specified by:
getParserForTypein interfacecom.google.protobuf.MessageLite- Overrides:
getParserForTypein classcom.google.protobuf.GeneratedMessageV3
-
getDefaultInstanceForType
public Service getDefaultInstanceForType()
- Specified by:
getDefaultInstanceForTypein interfacecom.google.protobuf.MessageLiteOrBuilder- Specified by:
getDefaultInstanceForTypein interfacecom.google.protobuf.MessageOrBuilder
-
-