Package com.google.api

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 Summary

    Modifier and Type
    Method
    Description
    String
    getAddress()
    The address of the API backend.
    com.google.protobuf.ByteString
    getAddressBytes()
    The address of the API backend.
    BackendRule.AuthenticationCase
    getAuthenticationCase()
     
    double
    getDeadline()
    The number of seconds to wait for a response from a request.
    boolean
    getDisableAuth()
    When disable_auth is true, a JWT ID token won't be generated and the original "Authorization" HTTP header will be preserved.
    String
    getJwtAudience()
    The JWT audience is used when generating a JWT ID token for the backend.
    com.google.protobuf.ByteString
    getJwtAudienceBytes()
    The JWT audience is used when generating a JWT ID token for the backend.
    double
    getMinDeadline()
    Minimum deadline in seconds needed for this method.
    double
    getOperationDeadline()
    The number of seconds to wait for the completion of a long running operation.
    BackendRule.PathTranslation
    getPathTranslation()
    .google.api.BackendRule.PathTranslation path_translation = 6;
    int
    getPathTranslationValue()
    .google.api.BackendRule.PathTranslation path_translation = 6;
    String
    getProtocol()
    The protocol used for sending a request to the backend.
    com.google.protobuf.ByteString
    getProtocolBytes()
    The protocol used for sending a request to the backend.
    String
    getSelector()
    Selects the methods to which this rule applies.
    com.google.protobuf.ByteString
    getSelectorBytes()
    Selects the methods to which this rule applies.
    boolean
    hasDisableAuth()
    When disable_auth is true, a JWT ID token won't be generated and the original "Authorization" HTTP header will be preserved.
    boolean
    hasJwtAudience()
    The JWT audience is used when generating a JWT ID token for the backend.

    Methods inherited from interface com.google.protobuf.MessageLiteOrBuilder

    isInitialized

    Methods inherited from interface com.google.protobuf.MessageOrBuilder

    findInitializationErrors, getAllFields, getDefaultInstanceForType, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof

  • 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

      double getMinDeadline()
       Minimum deadline in seconds needed for this method. Calls having deadline
 value lower than this will be rejected.
      double min_deadline = 4;
      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.

    • getAuthenticationCase

      BackendRule.AuthenticationCase getAuthenticationCase()