Class AuthenticationRule

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

System.Object

AuthenticationRule

Implements

IMessage<AuthenticationRule>

IMessage

System.IEquatable<AuthenticationRule>

IDeepCloneable<AuthenticationRule>

Inherited Members

System.Object.Equals(System.Object, System.Object)

System.Object.ReferenceEquals(System.Object, System.Object)

System.Object.GetType()

System.Object.MemberwiseClone()

Namespace: Google.Api

Assembly: Google.Api.CommonProtos.dll

Syntax

public sealed class AuthenticationRule : IMessage<AuthenticationRule>, IMessage, IEquatable<AuthenticationRule>, IDeepCloneable<AuthenticationRule>

Constructors

AuthenticationRule()

Declaration

public AuthenticationRule()

AuthenticationRule(AuthenticationRule)

Declaration

public AuthenticationRule(AuthenticationRule other)

Parameters

Type	Name	Description
AuthenticationRule	other

Fields

AllowWithoutCredentialFieldNumber

Field number for the "allow_without_credential" field.

Declaration

public const int AllowWithoutCredentialFieldNumber = 5

Field Value

Type	Description
System.Int32

OauthFieldNumber

Field number for the "oauth" field.

Declaration

public const int OauthFieldNumber = 2

Field Value

Type	Description
System.Int32

RequirementsFieldNumber

Field number for the "requirements" field.

Declaration

public const int RequirementsFieldNumber = 7

Field Value

Type	Description
System.Int32

SelectorFieldNumber

Field number for the "selector" field.

Declaration

public const int SelectorFieldNumber = 1

Field Value

Type	Description
System.Int32

Properties

AllowWithoutCredential

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

Declaration

public bool AllowWithoutCredential { get; set; }

Property Value

Type	Description
System.Boolean

Descriptor

Declaration

public static MessageDescriptor Descriptor { get; }

Property Value

Type	Description
MessageDescriptor

Oauth

The requirements for OAuth credentials.

Declaration

public OAuthRequirements Oauth { get; set; }

Property Value

Type	Description
OAuthRequirements

Parser

Declaration

public static MessageParser<AuthenticationRule> Parser { get; }

Property Value

Type	Description
MessageParser<AuthenticationRule>

Requirements

Requirements for additional authentication providers.

Declaration

public RepeatedField<AuthRequirement> Requirements { get; }

Property Value

Type	Description
RepeatedField<AuthRequirement>

Selector

Selects the methods to which this rule applies.

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

Declaration

public string Selector { get; set; }

Property Value

Type	Description
System.String

Methods

CalculateSize()

Declaration

public int CalculateSize()

Returns

Type	Description
System.Int32

Implements

IMessage.CalculateSize()

Clone()

Declaration

public AuthenticationRule Clone()

Returns

Type	Description
AuthenticationRule

Implements

IDeepCloneable<T>.Clone()

Equals(AuthenticationRule)

Declaration

public bool Equals(AuthenticationRule other)

Parameters

Type	Name	Description
AuthenticationRule	other

Returns

Type	Description
System.Boolean

Implements

System.IEquatable<T>.Equals(T)

Equals(Object)

Declaration

public override bool Equals(object other)

Parameters

Type	Name	Description
System.Object	other

Returns

Type	Description
System.Boolean

Overrides

System.Object.Equals(System.Object)

GetHashCode()

Declaration

public override int GetHashCode()

Returns

Type	Description
System.Int32

Overrides

System.Object.GetHashCode()

MergeFrom(AuthenticationRule)

Declaration

public void MergeFrom(AuthenticationRule other)

Parameters

Type	Name	Description
AuthenticationRule	other

Implements

IMessage<T>.MergeFrom(T)

MergeFrom(CodedInputStream)

Declaration

public void MergeFrom(CodedInputStream input)

Parameters

Type	Name	Description
CodedInputStream	input

Implements

IMessage.MergeFrom(CodedInputStream)

ToString()

Declaration

public override string ToString()

Returns

Type	Description
System.String

Overrides

System.Object.ToString()

WriteTo(CodedOutputStream)

Declaration

public void WriteTo(CodedOutputStream output)

Parameters

Type	Name	Description
CodedOutputStream	output

Implements

IMessage.WriteTo(CodedOutputStream)

Explicit Interface Implementations

IMessage.Descriptor

Declaration

MessageDescriptor IMessage.Descriptor { get; }

Returns

Type	Description
MessageDescriptor

Implements

IMessage.Descriptor