google_api_service_management v0.34.0 GoogleApi.ServiceManagement.V1.Model.BackendRule View Source

A backend rule provides configuration for an individual API element.

Attributes

  • address (type: String.t, default: nil) - The address of the API backend.

  • deadline (type: float(), default: nil) - The number of seconds to wait for a response from a request. The default deadline for gRPC is infinite (no deadline) and HTTP requests is 5 seconds.

  • disableAuth (type: boolean(), default: nil) - When disable_auth is false, a JWT ID token will be generated with the value from BackendRule.address as jwt_audience, overrode to the HTTP "Authorization" request header and sent to the backend.

    When disable_auth is true, a JWT ID token won't be generated and the original "Authorization" HTTP header will be preserved. If the header is used to carry the original token and is expected by the backend, this field must be set to true to preserve the header.

  • jwtAudience (type: String.t, default: nil) - The JWT audience is used when generating a JWT ID token for the backend. This ID token will be added in the HTTP "authorization" header, and sent to the backend.

  • minDeadline (type: float(), default: nil) - Minimum deadline in seconds needed for this method. Calls having deadline value lower than this will be rejected.

  • operationDeadline (type: float(), default: nil) - The number of seconds to wait for the completion of a long running operation. The default is no deadline.

  • pathTranslation (type: String.t, default: nil) -

  • selector (type: String.t, default: nil) - Selects the methods to which this rule applies.

    Refer to selector for syntax details.

Link to this section Summary

Functions

Unwrap a decoded JSON object into its complex fields.

Link to this section Types

Link to this type

t()

View Source
t() :: %GoogleApi.ServiceManagement.V1.Model.BackendRule{
  address: String.t(),
  deadline: float(),
  disableAuth: boolean(),
  jwtAudience: String.t(),
  minDeadline: float(),
  operationDeadline: float(),
  pathTranslation: String.t(),
  selector: String.t()
}

Link to this section Functions

Link to this function

decode(value, options)

View Source
decode(struct(), keyword()) :: struct()

Unwrap a decoded JSON object into its complex fields.