// Code generated by sidekick. DO NOT EDIT.
//
// Copyright 2026 Google LLC
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
//     https://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.

#if RegionUrlMaps || UrlMaps
  import Foundation
  import GoogleCloudWkt

  /// Specifies settings for an HTTP redirect.
  public struct HttpRedirectAction: Codable, Equatable, GoogleCloudWkt._AnyPackable,
    Sendable
  {
    /// The host that is used in the redirect response instead of the one that
    /// was supplied in the request.
    ///
    /// The value must be from 1 to 255
    /// characters.
    public var hostRedirect: Swift.String? = nil

    /// If set to true, the URL scheme in the redirected request is
    /// set to HTTPS.
    /// If set to false, the URL scheme of the redirected request
    /// remains the same as that of the request.
    ///
    /// This must only be set for URL maps used inTargetHttpProxys. Setting this true forTargetHttpsProxy is not permitted.
    ///
    /// The default is set to false.
    public var httpsRedirect: Swift.Bool? = nil

    /// The path that is used in the redirect response instead of the one
    /// that was supplied in the request.
    ///
    /// pathRedirect cannot be supplied together withprefixRedirect. Supply one alone or neither. If neither is
    /// supplied, the path of the original request is used for the redirect.
    ///
    /// The value must be from 1 to 1024 characters.
    public var pathRedirect: Swift.String? = nil

    /// The prefix that replaces the prefixMatch specified in
    /// the HttpRouteRuleMatch, retaining the remaining portion
    /// of the URL before redirecting the request.
    ///
    /// prefixRedirect cannot be supplied together withpathRedirect. Supply one alone or neither. If neither is
    /// supplied, the path of the original request is used for the redirect.
    ///
    /// The value must be from 1 to 1024 characters.
    public var prefixRedirect: Swift.String? = nil

    /// The HTTP Status code to use for this RedirectAction.
    ///
    /// Supported values are:
    ///
    ///    - MOVED_PERMANENTLY_DEFAULT, which is the default value and corresponds
    ///    to 301.
    ///    - FOUND, which corresponds to 302.
    ///    - SEE_OTHER which corresponds to 303.
    ///    - TEMPORARY_REDIRECT, which corresponds to 307. In this case, the request
    ///    method is retained.
    ///    - PERMANENT_REDIRECT, which corresponds to 308. In this case, the request
    ///    method is retained.
    public var redirectResponseCode: HttpRedirectAction.RedirectResponseCode? = nil

    /// If set to true, any accompanying query portion of the original
    /// URL is
    /// removed before redirecting the request. If set to false, the
    /// query portion of the original URL is retained.
    ///
    /// The default is set to false.
    public var stripQuery: Swift.Bool? = nil

    /// Initialize a new instance of `HttpRedirectAction`.
    public init() {}

    /// Use `config` to return a new instance of this object, with some fields updated.
    ///
    /// Commonly used to initialize the value, for example:
    ///
    /// ```
    /// let value = HttpRedirectAction().with { $0.hostRedirect = ... }
    /// ```
    public func with(_ config: (inout Self) throws -> Swift.Void) rethrows -> Self {
      var copy = self
      try config(&copy)
      return copy
    }

    /// The enumerated type for the [redirectResponseCode][google.cloud.compute.v1.HttpRedirectAction.redirectResponseCode] field.
    ///
    /// [google.cloud.compute.v1.HttpRedirectAction.redirectResponseCode]: <doc:HttpRedirectAction/RedirectResponseCode>
    public enum RedirectResponseCode: Codable, Equatable, Sendable {
      /// Http Status Code 302 - Found.
      case found
      /// Http Status Code 301 - Moved Permanently.
      case movedPermanentlyDefault
      /// Http Status Code 308 - Permanent Redirect maintaining HTTP method.
      case permanentRedirect
      /// Http Status Code 303 - See Other.
      case seeOther
      /// Http Status Code 307 - Temporary Redirect maintaining HTTP method.
      case temporaryRedirect
      /// Encodes an unknown integer value.
      ///
      /// The most common cause for an unknown values is for the service to send
      /// a value unknown to the library. We recommend you update your library to
      /// the latest version.
      case unknownIntValue(Int)
      /// Encodes an unknown string value.
      ///
      /// The most common cause for an unknown values is for the service to send
      /// a value unknown to the library. We recommend you update your library to
      /// the latest version.
      case unknownStringValue(String)

      public init() {
        self = .found
      }

      /// Returns the integer value associated with the enumeration.
      ///
      /// If the enumeration was initialized with an unknown string value, this returns `nil`.
      public var intValue: Int? {
        switch self {
        case .found: return 0
        case .movedPermanentlyDefault: return 1
        case .permanentRedirect: return 2
        case .seeOther: return 3
        case .temporaryRedirect: return 4
        case .unknownIntValue(let v): return v
        case .unknownStringValue: return nil
        }
      }

      /// Returns the string value (or name) associated with the enumeration.
      ///
      /// If the enumeration was initialized with an unknown integer value, this returns `nil`.
      public var stringValue: Swift.String? {
        switch self {
        case .found: return "FOUND"
        case .movedPermanentlyDefault: return "MOVED_PERMANENTLY_DEFAULT"
        case .permanentRedirect: return "PERMANENT_REDIRECT"
        case .seeOther: return "SEE_OTHER"
        case .temporaryRedirect: return "TEMPORARY_REDIRECT"
        case .unknownIntValue: return nil
        case .unknownStringValue(let v): return v
        }
      }

      /// Initialize from a string value.
      ///
      /// If the value is unknown, this initializes to [`unknownStringValue`](doc:RedirectResponseCode/unknownStringValue(_:)).
      public init(stringValue: Swift.String) {
        switch stringValue {
        case "FOUND": self = .found
        case "MOVED_PERMANENTLY_DEFAULT": self = .movedPermanentlyDefault
        case "PERMANENT_REDIRECT": self = .permanentRedirect
        case "SEE_OTHER": self = .seeOther
        case "TEMPORARY_REDIRECT": self = .temporaryRedirect
        default: self = .unknownStringValue(stringValue)
        }
      }

      /// Initialize from an integer value.
      ///
      /// If the value is unknown, this initializes to [`unknownIntValue`](doc:RedirectResponseCode/unknownIntValue(_:)).
      public init(intValue: Int) {
        switch intValue {
        case 0: self = .found
        case 1: self = .movedPermanentlyDefault
        case 2: self = .permanentRedirect
        case 3: self = .seeOther
        case 4: self = .temporaryRedirect
        default: self = .unknownIntValue(intValue)
        }
      }

      public init(from decoder: Decoder) throws {
        let container = try decoder.singleValueContainer()
        if let v = try? container.decode(Int.self) {
          self.init(intValue: v)
          return
        }
        if let s = try? container.decode(String.self) {
          if let v = Int(s) {
            self.init(intValue: v)
          } else {
            self.init(stringValue: s)
          }
          return
        }
        throw DecodingError.dataCorruptedError(
          in: container, debugDescription: "Expected enum value, must be integer or string.")
      }

      public func encode(to encoder: Encoder) throws {
        var container = encoder.singleValueContainer()
        switch self {
        case .found: return try container.encode(0)
        case .movedPermanentlyDefault: return try container.encode(1)
        case .permanentRedirect: return try container.encode(2)
        case .seeOther: return try container.encode(3)
        case .temporaryRedirect: return try container.encode(4)
        case .unknownIntValue(let v): return try container.encode(v)
        case .unknownStringValue(let v): return try container.encode(v)
        }
      }
    }

    public static var _anyTypeUrl: Swift.String {
      return "type.googleapis.com/google.cloud.compute.v1.HttpRedirectAction"
    }
    public init(fromAny any: GoogleCloudWkt.`Any`) throws {
      self = try GoogleCloudWkt._slowAnyDeserialize(Self.self, from: any)
    }
    public func _pack() throws -> GoogleCloudWkt.Struct {
      return try GoogleCloudWkt._slowAnySerialize(message: self)
    }
  }
#endif
