Class BackendRule

A backend rule provides configuration for an individual API element.

Inheritance

object

BackendRule

Implements

IDirectResponseSchema

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Namespace: Google.Apis.ServiceConsumerManagement.v1.Data

Assembly: Google.Apis.ServiceConsumerManagement.v1.dll

Syntax

public class BackendRule : IDirectResponseSchema

Properties

Address

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 to specify the protocol version.

Declaration

[JsonProperty("address")]
public virtual string Address { get; set; }

Property Value

Type	Description
string

Deadline

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

Declaration

[JsonProperty("deadline")]
public virtual double? Deadline { get; set; }

Property Value

Type	Description
double?

DisableAuth

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.

Declaration

[JsonProperty("disableAuth")]
public virtual bool? DisableAuth { get; set; }

Property Value

Type	Description
bool?

ETag

The ETag of the item.

Declaration

public virtual string ETag { get; set; }

Property Value

Type	Description
string

JwtAudience

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.

Declaration

[JsonProperty("jwtAudience")]
public virtual string JwtAudience { get; set; }

Property Value

Type	Description
string

MinDeadline

Deprecated, do not use.

Declaration

[JsonProperty("minDeadline")]
public virtual double? MinDeadline { get; set; }

Property Value

Type	Description
double?

OperationDeadline

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

Declaration

[JsonProperty("operationDeadline")]
public virtual double? OperationDeadline { get; set; }

Property Value

Type	Description
double?

OverridesByRequestProtocol

The map between request protocol and the backend address.

Declaration

[JsonProperty("overridesByRequestProtocol")]
public virtual IDictionary<string, BackendRule> OverridesByRequestProtocol { get; set; }

Property Value

Type	Description
IDictionary<string, BackendRule>

PathTranslation

Declaration

[JsonProperty("pathTranslation")]
public virtual string PathTranslation { get; set; }

Property Value

Type	Description
string

Protocol

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 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.

Declaration

[JsonProperty("protocol")]
public virtual string Protocol { get; set; }

Property Value

Type	Description
string

Selector

Selects the methods to which this rule applies. Refer to selector for syntax details.

Declaration

[JsonProperty("selector")]
public virtual string Selector { get; set; }

Property Value

Type	Description
string

Implements

IDirectResponseSchema