PHPFUI/InstaDoc

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 google.api.AuthenticationRule

CloneableInstantiable

Extends
Google\Protobuf\Internal\Message

Methods

public __construct( $data = NULL)

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 Google\Protobuf\Internal\Message::__debugInfo()

public Google\Protobuf\Internal\Message::byteSize()

ignore

public Google\Protobuf\Internal\Message::clear()

Clear all containing fields.

return null

public clearOauth()

public Google\Protobuf\Internal\Message::discardUnknownFields()

Clear all unknown fields previously parsed.

return null

public getAllowWithoutCredential()

If true, the service accepts API keys without any other credential.

This flag only applies to HTTP and gRPC requests.

Generated from protobuf field bool allow_without_credential = 5;

return bool

public getOauth()

The requirements for OAuth credentials.

Generated from protobuf field .google.api.OAuthRequirements oauth = 2;

return \Google\Api\OAuthRequirements|null

public getRequirements()

Requirements for additional authentication providers.

Generated from protobuf field repeated .google.api.AuthRequirement requirements = 7;

return \Google\Protobuf\Internal\RepeatedField

public getSelector()

Selects the methods to which this rule applies.

Refer to [selector][google.api.DocumentationRule.selector] for syntax details.

Generated from protobuf field string selector = 1;

return string

public hasOauth()

public Google\Protobuf\Internal\Message::jsonByteSize( $options = 0)

ignore

public Google\Protobuf\Internal\Message::mergeFrom( $msg)

Merges the contents of the specified message into current message.

This method merges the contents of the specified message into the current message. Singular fields that are set in the specified message overwrite the corresponding fields in the current message. Repeated fields are appended. Map fields key-value pairs are overwritten. Singular/Oneof sub-messages are recursively merged. All overwritten sub-messages are deep-copied.

param object $msg Protobuf message to be merged from.
return null

public Google\Protobuf\Internal\Message::mergeFromJsonString( $data, $ignore_unknown = false)

Parses a json string to protobuf message.

This function takes a string in the json wire format, matching the encoding output by serializeToJsonString(). See mergeFrom() for merging behavior, if the field is already set in the specified message.

param string $data Json protobuf data.
param bool $ignore_unknown
return null
throws \Exception Invalid data.

public Google\Protobuf\Internal\Message::mergeFromString( $data)

Parses a protocol buffer contained in a string.

This function takes a string in the (non-human-readable) binary wire format, matching the encoding output by serializeToString(). See mergeFrom() for merging behavior, if the field is already set in the specified message.

param string $data Binary protobuf data.
return null
throws \Exception Invalid data.

public Google\Protobuf\Internal\Message::parseFromJsonStream( $input, $ignore_unknown)

ignore

public Google\Protobuf\Internal\Message::parseFromStream( $input)

ignore

public Google\Protobuf\Internal\Message::serializeToJsonStream( $output)

ignore

public Google\Protobuf\Internal\Message::serializeToJsonString( $options = 0)

Serialize the message to json string.

return string Serialized json protobuf data.

public Google\Protobuf\Internal\Message::serializeToStream( $output)

ignore

public Google\Protobuf\Internal\Message::serializeToString()

Serialize the message to string.

return string Serialized binary protobuf data.

public setAllowWithoutCredential( $var)

If true, the service accepts API keys without any other credential.

This flag only applies to HTTP and gRPC requests.

Generated from protobuf field bool allow_without_credential = 5;

param bool $var
return $this

public setOauth( $var)

The requirements for OAuth credentials.

Generated from protobuf field .google.api.OAuthRequirements oauth = 2;

param \Google\Api\OAuthRequirements $var
return $this

public setRequirements( $var)

Requirements for additional authentication providers.

Generated from protobuf field repeated .google.api.AuthRequirement requirements = 7;

param \Google\Api\AuthRequirement[]|\Google\Protobuf\Internal\RepeatedField $var
return $this

public setSelector( $var)

Selects the methods to which this rule applies.

Refer to [selector][google.api.DocumentationRule.selector] for syntax details.

Generated from protobuf field string selector = 1;

param string $var
return $this

Properties

protected $allow_without_credential = false

If true, the service accepts API keys without any other credential.

This flag only applies to HTTP and gRPC requests.

Generated from protobuf field bool allow_without_credential = 5;

protected $oauth = NULL

The requirements for OAuth credentials.

Generated from protobuf field .google.api.OAuthRequirements oauth = 2;

protected $selector = ''

Selects the methods to which this rule applies.

Refer to [selector][google.api.DocumentationRule.selector] for syntax details.

Generated from protobuf field string selector = 1;

Methods

protected Google\Protobuf\Internal\Message::hasOneof( $number)

protected Google\Protobuf\Internal\Message::mergeFromArray(array $array)

Populates the message from a user-supplied PHP array. Array keys correspond to Message properties and nested message properties.

Example:

$message->mergeFromArray([
    'name' => 'This is a message name',
    'interval' => [
         'startTime' => time() - 60,
         'endTime' => time(),
    ]
]);

This method will trigger an error if it is passed data that cannot be converted to the correct type. For example, a StringValue field must receive data that is either a string or a StringValue object.

param array $array An array containing message properties and values.
return null

protected Google\Protobuf\Internal\Message::mergeFromJsonArray( $array, $ignore_unknown)

protected Google\Protobuf\Internal\Message::readOneof( $number)

protected Google\Protobuf\Internal\Message::readWrapperValue( $member)

protected Google\Protobuf\Internal\Message::whichOneof( $oneof_name)

protected Google\Protobuf\Internal\Message::writeOneof( $number, $value)

protected Google\Protobuf\Internal\Message::writeWrapperValue( $member, $value)

Properties

private $requirements = NULL

Requirements for additional authentication providers.

Generated from protobuf field repeated .google.api.AuthRequirement requirements = 7;