GoogleApi.ServiceControl.V2.Model.Api (google_api_service_control v0.37.2) View Source

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 (type: String.t, default: nil) - 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 (type: String.t, default: nil) - The API protocol used for sending the request, such as "http", "https", "grpc", or "internal".
  • service (type: String.t, default: nil) - 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 (type: String.t, default: nil) - The API version associated with the API operation above, such as "v1" or "v1alpha1".

Link to this section Summary

Functions

Unwrap a decoded JSON object into its complex fields.

Link to this section Types

Specs

t() :: %GoogleApi.ServiceControl.V2.Model.Api{
  operation: String.t() | nil,
  protocol: String.t() | nil,
  service: String.t() | nil,
  version: String.t() | nil
}

Link to this section Functions

Specs

decode(struct(), keyword()) :: struct()

Unwrap a decoded JSON object into its complex fields.