// 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 MetadataService
  import Foundation
  import GoogleCloudWkt

  /// Instance of a general MetadataSchema.
  public struct MetadataSchema: Codable, Equatable, GoogleCloudWkt._AnyPackable,
    Sendable
  {
    /// Output only. The resource name of the MetadataSchema.
    public var name: Swift.String = Swift.String()

    /// The version of the MetadataSchema. The version's format must match
    /// the following regular expression: `^[0-9]+[.][0-9]+[.][0-9]+$`, which would
    /// allow to order/compare different versions. Example: 1.0.0, 1.0.1, etc.
    public var schemaVersion: Swift.String = Swift.String()

    /// Required. The raw YAML string representation of the MetadataSchema. The
    /// combination of [MetadataSchema.version] and the schema name given by
    /// `title` in [MetadataSchema.schema] must be unique within a MetadataStore.
    ///
    /// The schema is defined as an OpenAPI 3.0.2
    /// [MetadataSchema
    /// Object](https://github.com/OAI/OpenAPI-Specification/blob/master/versions/3.0.2.md#schemaObject)
    public var schema: Swift.String = Swift.String()

    /// The type of the MetadataSchema. This is a property that identifies which
    /// metadata types will use the MetadataSchema.
    public var schemaType: MetadataSchema.MetadataSchemaType = MetadataSchema.MetadataSchemaType()

    /// Output only. Timestamp when this MetadataSchema was created.
    public var createTime: GoogleCloudWkt.Timestamp? = nil

    /// Description of the Metadata Schema
    public var description: Swift.String = Swift.String()

    /// Initialize a new instance of `MetadataSchema`.
    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 = MetadataSchema().with { $0.name = ... }
    /// ```
    public func with(_ config: (inout Self) throws -> Swift.Void) rethrows -> Self {
      var copy = self
      try config(&copy)
      return copy
    }

    /// Describes the type of the MetadataSchema.
    public enum MetadataSchemaType: Codable, Equatable, Sendable {
      /// Unspecified type for the MetadataSchema.
      case unspecified
      /// A type indicating that the MetadataSchema will be used by Artifacts.
      case artifactType
      /// A typee indicating that the MetadataSchema will be used by Executions.
      case executionType
      /// A state indicating that the MetadataSchema will be used by Contexts.
      case contextType
      /// 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 = .unspecified
      }

      /// 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 .unspecified: return 0
        case .artifactType: return 1
        case .executionType: return 2
        case .contextType: return 3
        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 .unspecified: return "METADATA_SCHEMA_TYPE_UNSPECIFIED"
        case .artifactType: return "ARTIFACT_TYPE"
        case .executionType: return "EXECUTION_TYPE"
        case .contextType: return "CONTEXT_TYPE"
        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:MetadataSchemaType/unknownStringValue(_:)).
      public init(stringValue: Swift.String) {
        switch stringValue {
        case "METADATA_SCHEMA_TYPE_UNSPECIFIED": self = .unspecified
        case "ARTIFACT_TYPE": self = .artifactType
        case "EXECUTION_TYPE": self = .executionType
        case "CONTEXT_TYPE": self = .contextType
        default: self = .unknownStringValue(stringValue)
        }
      }

      /// Initialize from an integer value.
      ///
      /// If the value is unknown, this initializes to [`unknownIntValue`](doc:MetadataSchemaType/unknownIntValue(_:)).
      public init(intValue: Int) {
        switch intValue {
        case 0: self = .unspecified
        case 1: self = .artifactType
        case 2: self = .executionType
        case 3: self = .contextType
        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 .unspecified: return try container.encode(0)
        case .artifactType: return try container.encode(1)
        case .executionType: return try container.encode(2)
        case .contextType: return try container.encode(3)
        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.aiplatform.v1.MetadataSchema"
    }
    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
