Class AttributeContext.Types.Api (2.2.0)

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

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

Implements

Protobuf.IBufferMessage

Namespace

Google.Rpc.Context

Assembly

Google.Api.CommonProtos.dll

Constructors

Api()

public Api()

Api(AttributeContext.Types.Api)

public Api(AttributeContext.Types.Api other)

Parameter
Name	Description
`other`	`AttributeContext.Types.Api`

Fields

OperationFieldNumber

public const int OperationFieldNumber = 2

Field number for the "operation" field.

Field Value
Type	Description
`Int32`

ProtocolFieldNumber

public const int ProtocolFieldNumber = 3

Field number for the "protocol" field.

Field Value
Type	Description
`Int32`

ServiceFieldNumber

public const int ServiceFieldNumber = 1

Field number for the "service" field.

Field Value
Type	Description
`Int32`

VersionFieldNumber

public const int VersionFieldNumber = 4

Field number for the "version" field.

Field Value
Type	Description
`Int32`

Properties

Descriptor

public static Protobuf.Reflection.MessageDescriptor Descriptor { get; }

Property Value
Type	Description
`Protobuf.Reflection.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 Protobuf.MessageParser<AttributeContext.Types.Api> Parser { get; }

Property Value
Type	Description
`Protobuf.MessageParser<AttributeContext.Types.Api>`

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()

Returns
Type	Description
`Int32`

Clone()

public AttributeContext.Types.Api Clone()

Returns
Type	Description
`AttributeContext.Types.Api`

Equals(AttributeContext.Types.Api)

public bool Equals(AttributeContext.Types.Api other)

Parameter
Name	Description
`other`	`AttributeContext.Types.Api`

Returns
Type	Description
`Boolean`

Equals(Object)

public override bool Equals(object other)

Parameter
Name	Description
`other`	`Object`

Returns
Type	Description
`Boolean`

GetHashCode()

public override int GetHashCode()

Returns
Type	Description
`Int32`

MergeFrom(Protobuf.CodedInputStream)

public void MergeFrom(Protobuf.CodedInputStream input)

Parameter
Name	Description
`input`	`Protobuf.CodedInputStream`

MergeFrom(AttributeContext.Types.Api)

public void MergeFrom(AttributeContext.Types.Api other)

Parameter
Name	Description
`other`	`AttributeContext.Types.Api`

ToString()

public override string ToString()

Returns
Type	Description
`String`

WriteTo(Protobuf.CodedOutputStream)

public void WriteTo(Protobuf.CodedOutputStream output)

Parameter
Name	Description
`output`	`Protobuf.CodedOutputStream`