Class: Google::Protobuf::Api

Inherits:
Object
  • Object
show all
Extended by:
MessageExts::ClassMethods
Includes:
MessageExts
Defined in:
proto_docs/google/protobuf/api.rb

Overview

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.

Instance Attribute Summary collapse

Instance Attribute Details

#methods ⇒ ::Array<::Google::Protobuf::Method>

Returns The methods of this interface, in unspecified order.

Returns:



72
73
74
75
 
# File 'proto_docs/google/protobuf/api.rb', line 72

class Api
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end

#mixins ⇒ ::Array<::Google::Protobuf::Mixin>

Returns Included interfaces. See [Mixin][].

Returns:



72
73
74
75
 
# File 'proto_docs/google/protobuf/api.rb', line 72

class Api
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end

#name ⇒ ::String

Returns 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.



72
73
74
75
 
# File 'proto_docs/google/protobuf/api.rb', line 72

class Api
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end

#options ⇒ ::Array<::Google::Protobuf::Option>

Returns Any metadata attached to the interface.

Returns:



72
73
74
75
 
# File 'proto_docs/google/protobuf/api.rb', line 72

class Api
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end

#source_context ⇒ ::Google::Protobuf::SourceContext

Returns Source context for the protocol buffer service represented by this message.

Returns:



72
73
74
75
 
# File 'proto_docs/google/protobuf/api.rb', line 72

class Api
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end

#syntax ⇒ ::Google::Protobuf::Syntax

Returns The source syntax of the service.

Returns:



72
73
74
75
 
# File 'proto_docs/google/protobuf/api.rb', line 72

class Api
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end

#version ⇒ ::String

Returns 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.



72
73
74
75
 
# File 'proto_docs/google/protobuf/api.rb', line 72

class Api
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end