Class AttributeContext.Types.Api (2.15.0) 

public sealed class AttributeContext.Types.Api : IMessage<AttributeContext.Types.Api>, IEquatable<AttributeContext.Types.Api>, IDeepCloneable<AttributeContext.Types.Api>, IBufferMessage, IMessage

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 > AttributeContext.Types.Api

Namespace

Google.Rpc.Context

Assembly

Google.Api.CommonProtos.dll

Constructors

Api()

public Api()

Api(Api)

public Api(AttributeContext.Types.Api other)
Parameter
Name Description
other AttributeContextTypesApi

Fields

OperationFieldNumber

public const int OperationFieldNumber = 2

Field number for the "operation" field.

Field Value
Type Description
int

ProtocolFieldNumber

public const int ProtocolFieldNumber = 3

Field number for the "protocol" field.

Field Value
Type Description
int

ServiceFieldNumber

public const int ServiceFieldNumber = 1

Field number for the "service" field.

Field Value
Type Description
int

VersionFieldNumber

public const int VersionFieldNumber = 4

Field number for the "version" field.

Field Value
Type Description
int

Properties

Descriptor

public static MessageDescriptor Descriptor { get; }
Property Value
Type Description
MessageDescriptor

Operation

public string Operation { get; set; }

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

Property Value
Type Description
string

Parser

public static MessageParser<AttributeContext.Types.Api> Parser { get; }
Property Value
Type Description
MessageParserAttributeContextTypesApi

Protocol

public string Protocol { get; set; }

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

Property Value
Type Description
string

Service

public string Service { get; set; }

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.

Property Value
Type Description
string

Version

public string Version { get; set; }

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

Property Value
Type Description
string

Methods

CalculateSize()

public int CalculateSize()

Calculates the size of this message in Protocol Buffer wire format, in bytes.

Returns
Type Description
int

The number of bytes required to write this message to a coded output stream.

Clone()

public AttributeContext.Types.Api Clone()

Creates a deep clone of this object.

Returns
Type Description
AttributeContextTypesApi

A deep clone of this object.

Equals(Api)

public bool Equals(AttributeContext.Types.Api other)
Parameter
Name Description
other AttributeContextTypesApi
Returns
Type Description
bool

Equals(object)

public override bool Equals(object other)
Parameter
Name Description
other object
Returns
Type Description
bool
Overrides

GetHashCode()

public override int GetHashCode()
Returns
Type Description
int
Overrides

MergeFrom(CodedInputStream)

public void MergeFrom(CodedInputStream input)

Merges the data from the specified coded input stream with the current message.

Parameter
Name Description
input CodedInputStream
Remarks

See the user guide for precise merge semantics.

MergeFrom(Api)

public void MergeFrom(AttributeContext.Types.Api other)

Merges the given message into this one.

Parameter
Name Description
other AttributeContextTypesApi
Remarks

See the user guide for precise merge semantics.

ToString()

public override string ToString()
Returns
Type Description
string
Overrides

WriteTo(CodedOutputStream)

public void WriteTo(CodedOutputStream output)

Writes the data to the given coded output stream.

Parameter
Name Description
output CodedOutputStream

Coded output stream to write the data to. Must not be null.