Service Usage V1 API - Class Google::Protobuf::Api (v0.6.2)

Reference documentation and code samples for the Service Usage V1 API class Google::Protobuf::Api.

Api is a light-weight descriptor for an API Interface.

Interfaces are also described as "protocol buffer services" in some contexts, such as by the "service" keyword in a .proto file, but they are different from API Services, which represent a concrete implementation of an interface as opposed to simply a description of methods and bindings. They are also sometimes simply referred to as "APIs" in other contexts, such as the name of this message itself. See https://cloud.google.com/apis/design/glossary for detailed terminology.

Inherits

  • Object

Extended By

  • Google::Protobuf::MessageExts::ClassMethods

Includes

  • Google::Protobuf::MessageExts

Methods

#methods

defmethods()->::Array<::Google::Protobuf::Method>
Returns

#methods=

defmethods=(value)->::Array<::Google::Protobuf::Method>
Parameter
Returns

#mixins

defmixins()->::Array<::Google::Protobuf::Mixin>
Returns

#mixins=

defmixins=(value)->::Array<::Google::Protobuf::Mixin>
Parameter
Returns

#name

defname()->::String
Returns
  • (::String) — The fully qualified name of this interface, including package name followed by the interface's simple name.

#name=

defname=(value)->::String
Parameter
  • value (::String) — The fully qualified name of this interface, including package name followed by the interface's simple name.
Returns
  • (::String) — The fully qualified name of this interface, including package name followed by the interface's simple name.

#options

defoptions()->::Array<::Google::Protobuf::Option>
Returns

#options=

defoptions=(value)->::Array<::Google::Protobuf::Option>
Parameter
Returns

#source_context

defsource_context()->::Google::Protobuf::SourceContext
Returns

#source_context=

defsource_context=(value)->::Google::Protobuf::SourceContext
Parameter
Returns

#syntax

defsyntax()->::Google::Protobuf::Syntax
Returns

#syntax=

defsyntax=(value)->::Google::Protobuf::Syntax
Parameter
Returns

#version

defversion()->::String
Returns
  • (::String) — A version string for this interface. If specified, must have the form major-version.minor-version, as in 1.10. If the minor version is omitted, it defaults to zero. If the entire version field is empty, the major version is derived from the package name, as outlined below. If the field is not empty, the version in the package name will be verified to be consistent with what is provided here.

    The versioning schema uses semantic versioning where the major version number indicates a breaking change and the minor version an additive, non-breaking change. Both version numbers are signals to users what to expect from different versions, and should be carefully chosen based on the product plan.

    The major version is also reflected in the package name of the interface, which must end in v<major-version>, as in google.feature.v1. For major versions 0 and 1, the suffix can be omitted. Zero major versions must only be used for experimental, non-GA interfaces.

#version=

defversion=(value)->::String
Parameter
  • value (::String) — A version string for this interface. If specified, must have the form major-version.minor-version, as in 1.10. If the minor version is omitted, it defaults to zero. If the entire version field is empty, the major version is derived from the package name, as outlined below. If the field is not empty, the version in the package name will be verified to be consistent with what is provided here.

    The versioning schema uses semantic versioning where the major version number indicates a breaking change and the minor version an additive, non-breaking change. Both version numbers are signals to users what to expect from different versions, and should be carefully chosen based on the product plan.

    The major version is also reflected in the package name of the interface, which must end in v<major-version>, as in google.feature.v1. For major versions 0 and 1, the suffix can be omitted. Zero major versions must only be used for experimental, non-GA interfaces.

Returns
  • (::String) — A version string for this interface. If specified, must have the form major-version.minor-version, as in 1.10. If the minor version is omitted, it defaults to zero. If the entire version field is empty, the major version is derived from the package name, as outlined below. If the field is not empty, the version in the package name will be verified to be consistent with what is provided here.

    The versioning schema uses semantic versioning where the major version number indicates a breaking change and the minor version an additive, non-breaking change. Both version numbers are signals to users what to expect from different versions, and should be carefully chosen based on the product plan.

    The major version is also reflected in the package name of the interface, which must end in v<major-version>, as in google.feature.v1. For major versions 0 and 1, the suffix can be omitted. Zero major versions must only be used for experimental, non-GA interfaces.

Except as otherwise noted, the content of this page is licensed under the Creative Commons Attribution 4.0 License, and code samples are licensed under the Apache 2.0 License. For details, see the Google Developers Site Policies. Java is a registered trademark of Oracle and/or its affiliates.

Last updated 2025年10月30日 UTC.