class Google::Apis::ServicemanagementV1::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 cloud.google.com/apis/design/glossary for detailed terminology.

Attributes

methods_prop[RW]

The methods of this interface, in unspecified order. Corresponds to the JSON property `methods` @return [Array<Google::Apis::ServicemanagementV1::MethodProp>]

mixins[RW]

Included interfaces. See Mixin. Corresponds to the JSON property `mixins` @return [Array<Google::Apis::ServicemanagementV1::Mixin>]

name[RW]

The fully qualified name of this interface, including package name followed by the interface's simple name. Corresponds to the JSON property `name` @return [String]

options[RW]

Any metadata attached to the interface. Corresponds to the JSON property `options` @return [Array<Google::Apis::ServicemanagementV1::Option>]

source_context[RW]

`SourceContext` represents information about the source of a protobuf element, like the file in which it is defined. Corresponds to the JSON property `sourceContext` @return [Google::Apis::ServicemanagementV1::SourceContext]

syntax[RW]

The source syntax of the service. Corresponds to the JSON property `syntax` @return [String]

version[RW]

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](semver. org) 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`, 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. Corresponds to the JSON property `version` @return [String]

Public Class Methods

new(**args) click to toggle source
# File lib/google/apis/servicemanagement_v1/classes.rb, line 105
def initialize(**args)
   update!(**args)
end

Public Instance Methods

update!(**args) click to toggle source

Update properties of this object

# File lib/google/apis/servicemanagement_v1/classes.rb, line 110
def update!(**args)
  @methods_prop = args[:methods_prop] if args.key?(:methods_prop)
  @mixins = args[:mixins] if args.key?(:mixins)
  @name = args[:name] if args.key?(:name)
  @options = args[:options] if args.key?(:options)
  @source_context = args[:source_context] if args.key?(:source_context)
  @syntax = args[:syntax] if args.key?(:syntax)
  @version = args[:version] if args.key?(:version)
end