Class AuthenticationRule (2.2.0) 

public sealed class AuthenticationRule : Protobuf.IMessage<AuthenticationRule>, Protobuf.IBufferMessage

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.

Inheritance

Object > AuthenticationRule

Namespace

Google.Api

Assembly

Google.Api.CommonProtos.dll

Constructors

AuthenticationRule()

public AuthenticationRule()

AuthenticationRule(AuthenticationRule)

public AuthenticationRule(AuthenticationRule other)
Parameter
Name Description
other AuthenticationRule

Fields

AllowWithoutCredentialFieldNumber

public const int AllowWithoutCredentialFieldNumber = 5

Field number for the "allow_without_credential" field.

Field Value
Type Description
Int32

OauthFieldNumber

public const int OauthFieldNumber = 2

Field number for the "oauth" field.

Field Value
Type Description
Int32

RequirementsFieldNumber

public const int RequirementsFieldNumber = 7

Field number for the "requirements" field.

Field Value
Type Description
Int32

SelectorFieldNumber

public const int SelectorFieldNumber = 1

Field number for the "selector" field.

Field Value
Type Description
Int32

Properties

AllowWithoutCredential

public bool AllowWithoutCredential { get; set; }

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

Property Value
Type Description
Boolean

Descriptor

public static Protobuf.Reflection.MessageDescriptor Descriptor { get; }
Property Value
Type Description
Protobuf.Reflection.MessageDescriptor

Oauth

public OAuthRequirements Oauth { get; set; }

The requirements for OAuth credentials.

Property Value
Type Description
OAuthRequirements

Parser

public static Protobuf.MessageParser<AuthenticationRule> Parser { get; }
Property Value
Type Description
Protobuf.MessageParser<AuthenticationRule>

Requirements

public Protobuf.Collections.RepeatedField<AuthRequirement> Requirements { get; }

Requirements for additional authentication providers.

Property Value
Type Description
Protobuf.Collections.RepeatedField<AuthRequirement>

Selector

public string Selector { get; set; }

Selects the methods to which this rule applies.

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

Property Value
Type Description
String

Methods

CalculateSize()

public int CalculateSize()
Returns
Type Description
Int32

Clone()

public AuthenticationRule Clone()
Returns
Type Description
AuthenticationRule

Equals(AuthenticationRule)

public bool Equals(AuthenticationRule other)
Parameter
Name Description
other AuthenticationRule
Returns
Type Description
Boolean

Equals(Object)

public override bool Equals(object other)
Parameter
Name Description
other Object
Returns
Type Description
Boolean

GetHashCode()

public override int GetHashCode()
Returns
Type Description
Int32

MergeFrom(AuthenticationRule)

public void MergeFrom(AuthenticationRule other)
Parameter
Name Description
other AuthenticationRule

MergeFrom(Protobuf.CodedInputStream)

public void MergeFrom(Protobuf.CodedInputStream input)
Parameter
Name Description
input Protobuf.CodedInputStream

ToString()

public override string ToString()
Returns
Type Description
String

WriteTo(Protobuf.CodedOutputStream)

public void WriteTo(Protobuf.CodedOutputStream output)
Parameter
Name Description
output Protobuf.CodedOutputStream