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

Inheritance

object

Api

Implements

IDirectResponseSchema

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Namespace: Google.Apis.ServiceConsumerManagement.v1.Data

Assembly: Google.Apis.ServiceConsumerManagement.v1.dll

Syntax

public class Api : IDirectResponseSchema

Properties

ETag

The ETag of the item.

Declaration

public virtual string ETag { get; set; }

Property Value

Type	Description
string

Methods

The methods of this interface, in unspecified order.

Declaration

[JsonProperty("methods")]
public virtual IList<Method> Methods { get; set; }

Property Value

Type	Description
IList<Method>

Mixins

Included interfaces. See Mixin.

Declaration

[JsonProperty("mixins")]
public virtual IList<Mixin> Mixins { get; set; }

Property Value

Type	Description
IList<Mixin>

Name

The fully qualified name of this interface, including package name followed by the interface's simple name.

Declaration

[JsonProperty("name")]
public virtual string Name { get; set; }

Property Value

Type	Description
string

Options

Any metadata attached to the interface.

Declaration

[JsonProperty("options")]
public virtual IList<Option> Options { get; set; }

Property Value

Type	Description
IList<Option>

SourceContext

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

Declaration

[JsonProperty("sourceContext")]
public virtual SourceContext SourceContext { get; set; }

Property Value

Type	Description
SourceContext

Syntax

The source syntax of the service.

Declaration

[JsonProperty("syntax")]
public virtual string Syntax { get; set; }

Property Value

Type	Description
string

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.

Declaration

[JsonProperty("version")]
public virtual string Version { get; set; }

Property Value

Type	Description
string

Implements

IDirectResponseSchema