Viewing file:  AuthenticationRule.php (5.91 KB) -rw-r--r--
Select action/file-type:
 (+) |  (+) |  (+) | Code (+) | Session (+) |  (+) | SDB (+) |  (+) |  (+) |  (+) |  (+) |  (+) |
<?php
# Generated by the protocol buffer compiler. DO NOT EDIT!
# source: google/api/auth.proto
namespace Google\Api;
use Google\Protobuf\Internal\GPBType;
use Google\Protobuf\Internal\RepeatedField;
use Google\Protobuf\Internal\GPBUtil;
/**
* Authentication rules for the service.
* By default, if a method has any authentication requirements, every request
* must include a valid credential matching one of the requirements.
* It's an error to include more than one kind of credential in a single
* request.
* If a method doesn't have any auth requirements, request credentials will be
* ignored.
*
* Generated from protobuf message <code>google.api.AuthenticationRule</code>
*/
class AuthenticationRule extends \Google\Protobuf\Internal\Message
{
/**
* Selects the methods to which this rule applies.
* Refer to [selector][google.api.DocumentationRule.selector] for syntax
* details.
*
* Generated from protobuf field <code>string selector = 1;</code>
*/
protected $selector = '';
/**
* The requirements for OAuth credentials.
*
* Generated from protobuf field <code>.google.api.OAuthRequirements oauth = 2;</code>
*/
protected $oauth = null;
/**
* If true, the service accepts API keys without any other credential.
* This flag only applies to HTTP and gRPC requests.
*
* Generated from protobuf field <code>bool allow_without_credential = 5;</code>
*/
protected $allow_without_credential = false;
/**
* Requirements for additional authentication providers.
*
* Generated from protobuf field <code>repeated .google.api.AuthRequirement requirements = 7;</code>
*/
private $requirements;
/**
* Constructor.
*
* @param array $data {
* Optional. Data for populating the Message object.
*
* @type string $selector
* Selects the methods to which this rule applies.
* Refer to [selector][google.api.DocumentationRule.selector] for syntax
* details.
* @type \Google\Api\OAuthRequirements $oauth
* The requirements for OAuth credentials.
* @type bool $allow_without_credential
* If true, the service accepts API keys without any other credential.
* This flag only applies to HTTP and gRPC requests.
* @type array<\Google\Api\AuthRequirement>|\Google\Protobuf\Internal\RepeatedField $requirements
* Requirements for additional authentication providers.
* }
*/
public function __construct($data = NULL) {
\GPBMetadata\Google\Api\Auth::initOnce();
parent::__construct($data);
}
/**
* Selects the methods to which this rule applies.
* Refer to [selector][google.api.DocumentationRule.selector] for syntax
* details.
*
* Generated from protobuf field <code>string selector = 1;</code>
* @return string
*/
public function getSelector()
{
return $this->selector;
}
/**
* Selects the methods to which this rule applies.
* Refer to [selector][google.api.DocumentationRule.selector] for syntax
* details.
*
* Generated from protobuf field <code>string selector = 1;</code>
* @param string $var
* @return $this
*/
public function setSelector($var)
{
GPBUtil::checkString($var, True);
$this->selector = $var;
return $this;
}
/**
* The requirements for OAuth credentials.
*
* Generated from protobuf field <code>.google.api.OAuthRequirements oauth = 2;</code>
* @return \Google\Api\OAuthRequirements|null
*/
public function getOauth()
{
return $this->oauth;
}
public function hasOauth()
{
return isset($this->oauth);
}
public function clearOauth()
{
unset($this->oauth);
}
/**
* The requirements for OAuth credentials.
*
* Generated from protobuf field <code>.google.api.OAuthRequirements oauth = 2;</code>
* @param \Google\Api\OAuthRequirements $var
* @return $this
*/
public function setOauth($var)
{
GPBUtil::checkMessage($var, \Google\Api\OAuthRequirements::class);
$this->oauth = $var;
return $this;
}
/**
* If true, the service accepts API keys without any other credential.
* This flag only applies to HTTP and gRPC requests.
*
* Generated from protobuf field <code>bool allow_without_credential = 5;</code>
* @return bool
*/
public function getAllowWithoutCredential()
{
return $this->allow_without_credential;
}
/**
* If true, the service accepts API keys without any other credential.
* This flag only applies to HTTP and gRPC requests.
*
* Generated from protobuf field <code>bool allow_without_credential = 5;</code>
* @param bool $var
* @return $this
*/
public function setAllowWithoutCredential($var)
{
GPBUtil::checkBool($var);
$this->allow_without_credential = $var;
return $this;
}
/**
* Requirements for additional authentication providers.
*
* Generated from protobuf field <code>repeated .google.api.AuthRequirement requirements = 7;</code>
* @return \Google\Protobuf\Internal\RepeatedField
*/
public function getRequirements()
{
return $this->requirements;
}
/**
* Requirements for additional authentication providers.
*
* Generated from protobuf field <code>repeated .google.api.AuthRequirement requirements = 7;</code>
* @param array<\Google\Api\AuthRequirement>|\Google\Protobuf\Internal\RepeatedField $var
* @return $this
*/
public function setRequirements($var)
{
$arr = GPBUtil::checkRepeatedField($var, \Google\Protobuf\Internal\GPBType::MESSAGE, \Google\Api\AuthRequirement::class);
$this->requirements = $arr;
return $this;
}
}
|