Interface BackendRuleOrBuilder

All Superinterfaces:
com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder
All Known Implementing Classes:
BackendRule, BackendRule.Builder
public interface BackendRuleOrBuilder extends com.google.protobuf.MessageOrBuilder

  • Method Details

    • getSelector

      String getSelector()
      Selects the methods to which this rule applies.

Refer to [selector][google.api.DocumentationRule.selector] for syntax
details.
      string selector = 1;
      Returns:
      The selector.

    • getSelectorBytes

      com.google.protobuf.ByteString getSelectorBytes()
      Selects the methods to which this rule applies.

Refer to [selector][google.api.DocumentationRule.selector] for syntax
details.
      string selector = 1;
      Returns:
      The bytes for selector.

    • getAddress

      String getAddress()
      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.
      string address = 2;
      Returns:
      The address.

    • getAddressBytes

      com.google.protobuf.ByteString getAddressBytes()
      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.
      string address = 2;
      Returns:
      The bytes for address.

    • getDeadline

      double getDeadline()
      The number of seconds to wait for a response from a request. The default
varies based on the request protocol and deployment environment.
      double deadline = 3;
      Returns:
      The deadline.

    • getMinDeadline

      @Deprecated double getMinDeadline()
      Deprecated.
      google.api.BackendRule.min_deadline is deprecated. See google/api/backend.proto;l=124
      Deprecated, do not use.
      double min_deadline = 4 [deprecated = true];
      Returns:
      The minDeadline.

    • getOperationDeadline

      double getOperationDeadline()
      The number of seconds to wait for the completion of a long running
operation. The default is no deadline.
      double operation_deadline = 5;
      Returns:
      The operationDeadline.

    • getPathTranslationValue

      int getPathTranslationValue()
      .google.api.BackendRule.PathTranslation path_translation = 6;
      Returns:
      The enum numeric value on the wire for pathTranslation.

    • getPathTranslation

      BackendRule.PathTranslation getPathTranslation()
      .google.api.BackendRule.PathTranslation path_translation = 6;
      Returns:
      The pathTranslation.

    • hasJwtAudience

      boolean hasJwtAudience()
      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.
      string jwt_audience = 7;
      Returns:
      Whether the jwtAudience field is set.

    • getJwtAudience

      String getJwtAudience()
      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.
      string jwt_audience = 7;
      Returns:
      The jwtAudience.

    • getJwtAudienceBytes

      com.google.protobuf.ByteString getJwtAudienceBytes()
      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.
      string jwt_audience = 7;
      Returns:
      The bytes for jwtAudience.

    • hasDisableAuth

      boolean hasDisableAuth()
      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.
      bool disable_auth = 8;
      Returns:
      Whether the disableAuth field is set.

    • getDisableAuth

      boolean getDisableAuth()
      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.
      bool disable_auth = 8;
      Returns:
      The disableAuth.

    • getProtocol

      String getProtocol()
      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.
      string protocol = 9;
      Returns:
      The protocol.

    • getProtocolBytes

      com.google.protobuf.ByteString getProtocolBytes()
      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.
      string protocol = 9;
      Returns:
      The bytes for protocol.

    • getOverridesByRequestProtocolCount

      int getOverridesByRequestProtocolCount()
      The map between request protocol and the backend address.
      map<string, .google.api.BackendRule> overrides_by_request_protocol = 10;

    • containsOverridesByRequestProtocol

      boolean containsOverridesByRequestProtocol(String key)
      The map between request protocol and the backend address.
      map<string, .google.api.BackendRule> overrides_by_request_protocol = 10;

    • getOverridesByRequestProtocol

      @Deprecated Map<String, BackendRule> getOverridesByRequestProtocol()
      Deprecated.
      Use getOverridesByRequestProtocolMap() instead.

    • getOverridesByRequestProtocolMap

      Map<String, BackendRule> getOverridesByRequestProtocolMap()
      The map between request protocol and the backend address.
      map<string, .google.api.BackendRule> overrides_by_request_protocol = 10;

    • getOverridesByRequestProtocolOrDefault

      BackendRule getOverridesByRequestProtocolOrDefault(String key, BackendRule defaultValue)
      The map between request protocol and the backend address.
      map<string, .google.api.BackendRule> overrides_by_request_protocol = 10;

    • getOverridesByRequestProtocolOrThrow

      BackendRule getOverridesByRequestProtocolOrThrow(String key)
      The map between request protocol and the backend address.
      map<string, .google.api.BackendRule> overrides_by_request_protocol = 10;

    • getAuthenticationCase

      BackendRule.AuthenticationCase getAuthenticationCase()