// 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.

import Foundation
import GoogleCloudGax
import GoogleCloudWkt

/// Response message for
/// [HsmManagement.ListSingleTenantHsmInstances][google.cloud.kms.v1.HsmManagement.ListSingleTenantHsmInstances].
///
/// [google.cloud.kms.v1.HsmManagement.ListSingleTenantHsmInstances]: <doc:HsmManagement/listSingleTenantHsmInstances(request:)>
public struct ListSingleTenantHsmInstancesResponse: Codable, Equatable, GoogleCloudWkt._AnyPackable,
  GoogleCloudGax._PaginatedResponse,
  Sendable
{
  /// The list of
  /// [SingleTenantHsmInstances][google.cloud.kms.v1.SingleTenantHsmInstance].
  ///
  /// [google.cloud.kms.v1.SingleTenantHsmInstance]: <doc:SingleTenantHsmInstance>
  public var singleTenantHsmInstances: [SingleTenantHsmInstance] = []

  /// A token to retrieve next page of results. Pass this value in
  /// [ListSingleTenantHsmInstancesRequest.page_token][google.cloud.kms.v1.ListSingleTenantHsmInstancesRequest.page_token]
  /// to retrieve the next page of results.
  ///
  /// [google.cloud.kms.v1.ListSingleTenantHsmInstancesRequest.page_token]: <doc:ListSingleTenantHsmInstancesRequest/pageToken>
  public var nextPageToken: Swift.String = Swift.String()

  /// The total number of
  /// [SingleTenantHsmInstances][google.cloud.kms.v1.SingleTenantHsmInstance]
  /// that matched the query.
  ///
  /// This field is not populated if
  /// [ListSingleTenantHsmInstancesRequest.filter][google.cloud.kms.v1.ListSingleTenantHsmInstancesRequest.filter]
  /// is applied.
  ///
  /// [google.cloud.kms.v1.ListSingleTenantHsmInstancesRequest.filter]: <doc:ListSingleTenantHsmInstancesRequest/filter>
  /// [google.cloud.kms.v1.SingleTenantHsmInstance]: <doc:SingleTenantHsmInstance>
  public var totalSize: Swift.Int32 = Swift.Int32()

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

  public static var _anyTypeUrl: Swift.String {
    return "type.googleapis.com/google.cloud.kms.v1.ListSingleTenantHsmInstancesResponse"
  }
  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)
  }

  public func _getPaginatedItems() -> [SingleTenantHsmInstance] {
    return self.singleTenantHsmInstances
  }

  public func _nextPageToken() -> Swift.String {
    return self.nextPageToken
  }
}
