ApiResponse class

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.

Constructors

ApiResponse({required Input<List<MethodResponse>> methods, required Input<List<MixinResponse>> mixins, required Input<String> name, required Input<List<OptionResponse>> options, required Input<SourceContextResponse> sourceContext, required Input<String> syntax, required Input<String> version})
Creates a new ApiResponse. methods The methods of this interface, in unspecified order. mixins Included interfaces. See Mixin. name The fully qualified name of this interface, including package name followed by the interface's simple name. options Any metadata attached to the interface. sourceContext Source context for the protocol buffer service represented by this message. syntax The source syntax of the service. version 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, 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.
const
ApiResponse.fromMap(Map<String, dynamic> map)
factory

Properties

hashCode → int
The hash code for this object.
no setterinherited
methods → Input<List<MethodResponse>>
The methods of this interface, in unspecified order.
final
mixins → Input<List<MixinResponse>>
Included interfaces. See Mixin.
final
name → Input<String>
The fully qualified name of this interface, including package name followed by the interface's simple name.
final
options → Input<List<OptionResponse>>
Any metadata attached to the interface.
final
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited
sourceContext → Input<SourceContextResponse>
Source context for the protocol buffer service represented by this message.
final
syntax → Input<String>
The source syntax of the service.
final
version → Input<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, 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.
final

Methods

noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
toMap() → Map<String, dynamic>
toString() → String
A string representation of this object.
inherited

Operators

operator ==(Object other) → bool
The equality operator.
inherited