Class BackendRule (2.15.0)

 public sealed class BackendRule : IMessage<BackendRule>, IEquatable<BackendRule>, IDeepCloneable<BackendRule>, IBufferMessage, IMessage 

A backend rule provides configuration for an individual API element.

 public BackendRule() 

 public BackendRule(BackendRule other) 

  public 
  
 const 
  
 int 
  
 AddressFieldNumber 
  
 = 
  
 2 
 

Field number for the "address" field.

  public 
  
 const 
  
 int 
  
 DeadlineFieldNumber 
  
 = 
  
 3 
 

Field number for the "deadline" field.

  public 
  
 const 
  
 int 
  
 DisableAuthFieldNumber 
  
 = 
  
 8 
 

Field number for the "disable_auth" field.

  public 
  
 const 
  
 int 
  
 JwtAudienceFieldNumber 
  
 = 
  
 7 
 

Field number for the "jwt_audience" field.

  public 
  
 const 
  
 int 
  
 MinDeadlineFieldNumber 
  
 = 
  
 4 
 

Field number for the "min_deadline" field.

  public 
  
 const 
  
 int 
  
 OperationDeadlineFieldNumber 
  
 = 
  
 5 
 

Field number for the "operation_deadline" field.

  public 
  
 const 
  
 int 
  
 OverridesByRequestProtocolFieldNumber 
  
 = 
  
 10 
 

Field number for the "overrides_by_request_protocol" field.

  public 
  
 const 
  
 int 
  
 PathTranslationFieldNumber 
  
 = 
  
 6 
 

Field number for the "path_translation" field.

  public 
  
 const 
  
 int 
  
 ProtocolFieldNumber 
  
 = 
  
 9 
 

Field number for the "protocol" field.

  public 
  
 const 
  
 int 
  
 SelectorFieldNumber 
  
 = 
  
 1 
 

Field number for the "selector" field.

 public string Address { get; set; } 

The address of the API backend.

The scheme is used to determine the backend protocol and security. The following schemes are accepted:

SCHEME PROTOCOL SECURITY http:// HTTP None https:// HTTP TLS grpc:// gRPC None grpcs:// gRPC TLS

It is recommended to explicitly include a scheme. Leaving out the scheme may cause constrasting behaviors across platforms.

If the port is unspecified, the default is:

• 80 for schemes without TLS
• 443 for schemes with TLS

For HTTP backends, use [protocol][google.api.BackendRule.protocol] to specify the protocol version.

 public BackendRule.AuthenticationOneofCase AuthenticationCase { get; } 

 public double Deadline { get; set; } 

The number of seconds to wait for a response from a request. The default varies based on the request protocol and deployment environment.

 public static MessageDescriptor Descriptor { get; } 

 public bool DisableAuth { get; set; } 

When disable_auth is true, a JWT ID token won't be generated and the original "Authorization" HTTP header will be preserved. If the header is used to carry the original token and is expected by the backend, this field must be set to true to preserve the header.

 public bool HasDisableAuth { get; } 

Gets whether the "disable_auth" field is set

 public bool HasJwtAudience { get; } 

Gets whether the "jwt_audience" field is set

 public string JwtAudience { get; set; } 

The JWT audience is used when generating a JWT ID token for the backend. This ID token will be added in the HTTP "authorization" header, and sent to the backend.

  [Obsolete] 
 public double MinDeadline { get; set; } 
 

Deprecated, do not use.

 public double OperationDeadline { get; set; } 

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

 public MapField<string, BackendRule> OverridesByRequestProtocol { get; } 

The map between request protocol and the backend address.

 public static MessageParser<BackendRule> Parser { get; } 

 public BackendRule.Types.PathTranslation PathTranslation { get; set; } 

 public string Protocol { get; set; } 

The protocol used for sending a request to the backend. The supported values are "http/1.1" and "h2".

The default value is inferred from the scheme in the [address][google.api.BackendRule.address] field:

SCHEME PROTOCOL http:// http/1.1 https:// http/1.1 grpc:// h2 grpcs:// h2

For secure HTTP backends (https://) that support HTTP/2, set this field to "h2" for improved performance.

Configuring this field to non-default values is only supported for secure HTTP backends. This field will be ignored for all other backends.

See https://www.iana.org/assignments/tls-extensiontype-values/tls-extensiontype-values.xhtml#alpn-protocol-ids for more details on the supported values.

 public string Selector { get; set; } 

Selects the methods to which this rule applies.

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

 public int CalculateSize() 

Calculates the size of this message in Protocol Buffer wire format, in bytes.

 public void ClearAuthentication() 

 public void ClearDisableAuth() 

Clears the value of the oneof if it's currently set to "disable_auth"

 public void ClearJwtAudience() 

Clears the value of the oneof if it's currently set to "jwt_audience"

 public BackendRule Clone() 

Creates a deep clone of this object.

 public bool Equals(BackendRule other) 

 public override bool Equals(object other) 

 public override int GetHashCode() 

 public void MergeFrom(BackendRule other) 

Merges the given message into this one.

 public void MergeFrom(CodedInputStream input) 

Merges the data from the specified coded input stream with the current message.

 public override string ToString() 

 public void WriteTo(CodedOutputStream output) 

Writes the data to the given coded output stream.