Service Management V1 API - Class Google::Api::BackendRule (v0.5.0)

Reference documentation and code samples for the Service Management V1 API class Google::Api::BackendRule.

A backend rule provides configuration for an individual API element.

Inherits

  • Object

Extended By

  • Google::Protobuf::MessageExts::ClassMethods

Includes

  • Google::Protobuf::MessageExts

Methods

#address

def address() -> ::String
Returns
  • (::String) — 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.

#address=

def address=(value) -> ::String
Parameter
  • value (::String) — 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.

Returns
  • (::String) — 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.

#deadline

def deadline() -> ::Float
Returns
  • (::Float) — The number of seconds to wait for a response from a request. The default varies based on the request protocol and deployment environment.

#deadline=

def deadline=(value) -> ::Float
Parameter
  • value (::Float) — The number of seconds to wait for a response from a request. The default varies based on the request protocol and deployment environment.
Returns
  • (::Float) — The number of seconds to wait for a response from a request. The default varies based on the request protocol and deployment environment.

#disable_auth

def disable_auth() -> ::Boolean
Returns
  • (::Boolean) — 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.

#disable_auth=

def disable_auth=(value) -> ::Boolean
Parameter
  • value (::Boolean) — 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.
Returns
  • (::Boolean) — 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.

#jwt_audience

def jwt_audience() -> ::String
Returns
  • (::String) — 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.

#jwt_audience=

def jwt_audience=(value) -> ::String
Parameter
  • value (::String) — 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.
Returns
  • (::String) — 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.

#min_deadline

def min_deadline() -> ::Float
Returns
  • (::Float) — Deprecated, do not use.

#min_deadline=

def min_deadline=(value) -> ::Float
Parameter
  • value (::Float) — Deprecated, do not use.
Returns
  • (::Float) — Deprecated, do not use.

#operation_deadline

def operation_deadline() -> ::Float
Returns
  • (::Float) — The number of seconds to wait for the completion of a long running operation. The default is no deadline.

#operation_deadline=

def operation_deadline=(value) -> ::Float
Parameter
  • value (::Float) — The number of seconds to wait for the completion of a long running operation. The default is no deadline.
Returns
  • (::Float) — The number of seconds to wait for the completion of a long running operation. The default is no deadline.

#path_translation

def path_translation() -> ::Google::Api::BackendRule::PathTranslation
Returns

#path_translation=

def path_translation=(value) -> ::Google::Api::BackendRule::PathTranslation
Parameter
Returns

#protocol

def protocol() -> ::String
Returns
  • (::String) — 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.

#protocol=

def protocol=(value) -> ::String
Parameter
  • value (::String) — 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.

Returns
  • (::String) — 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.

#selector

def selector() -> ::String
Returns
  • (::String) — Selects the methods to which this rule applies.

    Refer to selector for syntax details.

#selector=

def selector=(value) -> ::String
Parameter
  • value (::String) — Selects the methods to which this rule applies.

    Refer to selector for syntax details.

Returns
  • (::String) — Selects the methods to which this rule applies.

    Refer to selector for syntax details.