GoogleApi.Apigee.V1.Model.GoogleCloudApigeeV1EnvironmentClientIPResolutionConfigHeaderIndexAlgorithm (google_api_apigee v0.54.0)

View Source

Resolves the client ip based on a custom header.

Attributes

  • ipHeaderIndex (type: integer(), default: nil) - Required. The index of the ip in the header. Positive indices 0, 1, 2, 3 chooses indices from the left (first ips) Negative indices -1, -2, -3 chooses indices from the right (last ips)
  • ipHeaderName (type: String.t, default: nil) - Required. The name of the header to extract the client ip from. We are currently only supporting the X-Forwarded-For header.

Summary

Functions

Unwrap a decoded JSON object into its complex fields.

Types

t()

@type t() ::
  %GoogleApi.Apigee.V1.Model.GoogleCloudApigeeV1EnvironmentClientIPResolutionConfigHeaderIndexAlgorithm{
    ipHeaderIndex: integer() | nil,
    ipHeaderName: String.t() | nil
  }

Functions

decode(value, options)

@spec decode(struct(), keyword()) :: struct()

Unwrap a decoded JSON object into its complex fields.