Show / Hide Table of Contents

Class Api

This message defines attributes associated with API operations, such as a network API request. The terminology is based on the conventions used by Google APIs, Istio, and OpenAPI.

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.ServiceControl.v2.Data
Assembly: Google.Apis.ServiceControl.v2.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

Operation

The API operation name. For gRPC requests, it is the fully qualified API method name, such as "google.pubsub.v1.Publisher.Publish". For OpenAPI requests, it is the operationId, such as "getPet".

Declaration
[JsonProperty("operation")]
public virtual string Operation { get; set; }
Property Value
Type Description
string

Protocol

The API protocol used for sending the request, such as "http", "https", "grpc", or "internal".

Declaration
[JsonProperty("protocol")]
public virtual string Protocol { get; set; }
Property Value
Type Description
string

Service

The API service name. It is a logical identifier for a networked API, such as "pubsub.googleapis.com". The naming syntax depends on the API management system being used for handling the request.

Declaration
[JsonProperty("service")]
public virtual string Service { get; set; }
Property Value
Type Description
string

Version

The API version associated with the API operation above, such as "v1" or "v1alpha1".

Declaration
[JsonProperty("version")]
public virtual string Version { get; set; }
Property Value
Type Description
string

Implements

IDirectResponseSchema
In this article
Back to top Generated by DocFX