Api

com.google.rpc.context.attribute_context.AttributeContext$.Api
See theApi companion object
final case class Api(service: String, operation: String, protocol: String, version: String, unknownFields: UnknownFieldSet) extends GeneratedMessage with Updatable[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.

Attributes

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

protocol

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

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.

version

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

Companion:
object
Source:
AttributeContext.scala
Graph
Supertypes
trait Updatable[Api]
trait GeneratedMessage
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any

Members list

Concise view

Value members

Concrete methods

def companion: Api.type

Attributes

Source:
AttributeContext.scala
def getField(`__field`: FieldDescriptor): PValue

Attributes

Source:
AttributeContext.scala
def getFieldByNumber(`__fieldNumber`: Int): Any

Attributes

Source:
AttributeContext.scala
override def serializedSize: Int

Attributes

Definition Classes
GeneratedMessage
Source:
AttributeContext.scala

Returns a human-readable ASCII format representation of this message.

Returns a human-readable ASCII format representation of this message.

The original message can be decoded from this format by using fromAscii on the companion object.

Attributes

Returns:

human-readable representation of this message.

Source:
AttributeContext.scala
def withOperation(`__v`: String): Api

Attributes

Source:
AttributeContext.scala
def withProtocol(`__v`: String): Api

Attributes

Source:
AttributeContext.scala
def withService(`__v`: String): Api

Attributes

Source:
AttributeContext.scala
def withUnknownFields(`__v`: UnknownFieldSet): Api

Attributes

Source:
AttributeContext.scala
def withVersion(`__v`: String): Api

Attributes

Source:
AttributeContext.scala
def writeTo(`_output__`: CodedOutputStream): Unit

Serializes the message into the given coded output stream

Serializes the message into the given coded output stream

Attributes

Source:
AttributeContext.scala

Inherited methods

Attributes

Inherited from:
Product

Attributes

Inherited from:
Product
final def toByteArray: Array[Byte]

Serializes the message and returns a byte array containing its raw bytes

Serializes the message and returns a byte array containing its raw bytes

Attributes

Inherited from:
GeneratedMessage
Source:
GeneratedMessageCompanion.scala
final def toByteString: ByteString

Serializes the message and returns a ByteString containing its raw bytes

Serializes the message and returns a ByteString containing its raw bytes

Attributes

Inherited from:
GeneratedMessage
Source:
GeneratedMessageCompanion.scala
final def toPMessage: PMessage

Attributes

Inherited from:
GeneratedMessage
Source:
GeneratedMessageCompanion.scala
def update(ms: Lens[Api, Api] => () => Api*): A

Attributes

Inherited from:
Updatable
Source:
Lenses.scala
final def writeDelimitedTo(output: OutputStream): Unit

Attributes

Inherited from:
GeneratedMessage
Source:
GeneratedMessageCompanion.scala
final def writeTo(output: OutputStream): Unit

Serializes the message into the given output stream

Serializes the message into the given output stream

Attributes

Inherited from:
GeneratedMessage
Source:
GeneratedMessageCompanion.scala