Show / Hide Table of Contents

Class BackendRule

A backend rule provides configuration for an individual API element.

Inheritance
System.Object
BackendRule
Implements
IMessage<BackendRule>
IMessage
System.IEquatable<BackendRule>
IDeepCloneable<BackendRule>
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 BackendRule : IMessage<BackendRule>, IMessage, IEquatable<BackendRule>, IDeepCloneable<BackendRule>

Constructors

BackendRule()

Declaration
public BackendRule()

BackendRule(BackendRule)

Declaration
public BackendRule(BackendRule other)
Parameters
Type Name Description
BackendRule other

Fields

AddressFieldNumber

Field number for the "address" field.

Declaration
public const int AddressFieldNumber = 2
Field Value
Type Description
System.Int32

DeadlineFieldNumber

Field number for the "deadline" field.

Declaration
public const int DeadlineFieldNumber = 3
Field Value
Type Description
System.Int32

JwtAudienceFieldNumber

Field number for the "jwt_audience" field.

Declaration
public const int JwtAudienceFieldNumber = 7
Field Value
Type Description
System.Int32

MinDeadlineFieldNumber

Field number for the "min_deadline" field.

Declaration
public const int MinDeadlineFieldNumber = 4
Field Value
Type Description
System.Int32

OperationDeadlineFieldNumber

Field number for the "operation_deadline" field.

Declaration
public const int OperationDeadlineFieldNumber = 5
Field Value
Type Description
System.Int32

PathTranslationFieldNumber

Field number for the "path_translation" field.

Declaration
public const int PathTranslationFieldNumber = 6
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

Address

The address of the API backend.

Declaration
public string Address { get; set; }
Property Value
Type Description
System.String

AuthenticationCase

Declaration
public BackendRule.AuthenticationOneofCase AuthenticationCase { get; }
Property Value
Type Description
BackendRule.AuthenticationOneofCase

Deadline

The number of seconds to wait for a response from a request. The default deadline for gRPC is infinite (no deadline) and HTTP requests is 5 seconds.

Declaration
public double Deadline { get; set; }
Property Value
Type Description
System.Double

Descriptor

Declaration
public static MessageDescriptor Descriptor { get; }
Property Value
Type Description
MessageDescriptor

JwtAudience

The JWT audience is used when generating a JWT id token for the backend.

Declaration
public string JwtAudience { get; set; }
Property Value
Type Description
System.String

MinDeadline

Minimum deadline in seconds needed for this method. Calls having deadline value lower than this will be rejected.

Declaration
public double MinDeadline { get; set; }
Property Value
Type Description
System.Double

OperationDeadline

The number of seconds to wait for the completion of a long running operation. The default is no deadline.

Declaration
public double OperationDeadline { get; set; }
Property Value
Type Description
System.Double

Parser

Declaration
public static MessageParser<BackendRule> Parser { get; }
Property Value
Type Description
MessageParser<BackendRule>

PathTranslation

Declaration
public BackendRule.Types.PathTranslation PathTranslation { get; set; }
Property Value
Type Description
BackendRule.Types.PathTranslation

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()

ClearAuthentication()

Declaration
public void ClearAuthentication()

Clone()

Declaration
public BackendRule Clone()
Returns
Type Description
BackendRule
Implements
IDeepCloneable<T>.Clone()

Equals(BackendRule)

Declaration
public bool Equals(BackendRule other)
Parameters
Type Name Description
BackendRule 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(BackendRule)

Declaration
public void MergeFrom(BackendRule other)
Parameters
Type Name Description
BackendRule 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
Back to top