<?php
/**
 * Elasticsearch PHP client
 *
 * @link      https://github.com/elastic/elasticsearch-php/
 * @copyright Copyright (c) Elasticsearch B.V (https://www.elastic.co)
 * @license   http://www.apache.org/licenses/LICENSE-2.0 Apache License, Version 2.0
 * @license   https://www.gnu.org/licenses/lgpl-2.1.html GNU Lesser General Public License, Version 2.1 
 * 
 * Licensed to Elasticsearch B.V under one or more agreements.
 * Elasticsearch B.V licenses this file to you under the Apache 2.0 License or
 * the GNU Lesser General Public License, Version 2.1, at your option.
 * See the LICENSE file in the project root for more information.
 */
declare(strict_types = 1);

namespace Elasticsearch\Endpoints\Security;

use Elasticsearch\Common\Exceptions\RuntimeException;
use Elasticsearch\Endpoints\AbstractEndpoint;

/**
 * Class SamlServiceProviderMetadata
 * Elasticsearch API name security.saml_service_provider_metadata
 *
 * NOTE: this file is autogenerated using util/GenerateEndpoints.php
 * and Elasticsearch 7.17.0 (bee86328705acaa9a6daede7140defd4d9ec56bd)
 */
class SamlServiceProviderMetadata extends AbstractEndpoint
{
    protected $realm_name;

    public function getURI(): string
    {
        $realm_name = $this->realm_name ?? null;

        if (isset($realm_name)) {
            return "/_security/saml/metadata/$realm_name";
        }
        throw new RuntimeException('Missing parameter for the endpoint security.saml_service_provider_metadata');
    }

    public function getParamWhitelist(): array
    {
        return [];
    }

    public function getMethod(): string
    {
        return 'GET';
    }

    public function setRealmName($realm_name): SamlServiceProviderMetadata
    {
        if (isset($realm_name) !== true) {
            return $this;
        }
        $this->realm_name = $realm_name;

        return $this;
    }
}
