Class: Google::Apis::ServiceusageV1::JwtLocation

Inherits:

Object

• Object
• Google::Apis::ServiceusageV1::JwtLocation

Includes:

Core::Hashable, Core::JsonObjectSupport

Defined in:

generated/google/apis/serviceusage_v1/classes.rb,
generated/google/apis/serviceusage_v1/representations.rb,
generated/google/apis/serviceusage_v1/representations.rb

Overview

Specifies a location to extract JWT from an API request.

Instance Attribute Summary

• #header ⇒ String

  Specifies HTTP header name to extract JWT token.

• #query ⇒ String

  Specifies URL query parameter name to extract JWT token.

• #value_prefix ⇒ String

  The value prefix.

Instance Method Summary

• #initialize(**args) ⇒ JwtLocation constructor

  A new instance of JwtLocation.

• #update!(**args) ⇒ Object

  Update properties of this object.

Constructor Details

#initialize(**args) ⇒ JwtLocation

Returns a new instance of JwtLocation.

# File 'generated/google/apis/serviceusage_v1/classes.rb', line 2217

def initialize(**args)
   update!(**args)
end

Instance Attribute Details

#header ⇒ String

Specifies HTTP header name to extract JWT token. Corresponds to the JSON property header

Returns:

• (String)

# File 'generated/google/apis/serviceusage_v1/classes.rb', line 2200

def header
  @header
end

#query ⇒ String

Specifies URL query parameter name to extract JWT token. Corresponds to the JSON property query

Returns:

• (String)

# File 'generated/google/apis/serviceusage_v1/classes.rb', line 2205

def query
  @query
end

#value_prefix ⇒ String

The value prefix. The value format is "value_prefixtoken" Only applies to " in" header type. Must be empty for "in" query type. If not empty, the header value has to match (case sensitive) this prefix. If not matched, JWT will not be extracted. If matched, JWT will be extracted after the prefix is removed. For example, for "Authorization: Bearer JWT", value_prefix="Bearer " with a space at the end. Corresponds to the JSON property valuePrefix

Returns:

• (String)

# File 'generated/google/apis/serviceusage_v1/classes.rb', line 2215

def value_prefix
  @value_prefix
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object

# File 'generated/google/apis/serviceusage_v1/classes.rb', line 2222

def update!(**args)
  @header = args[:header] if args.key?(:header)
  @query = args[:query] if args.key?(:query)
  @value_prefix = args[:value_prefix] if args.key?(:value_prefix)
end