BackendRule (Service Networking API v1beta-rev20241113-2.0.0)

java.lang.Object
- java.util.AbstractMap<String,Object>
- - com.google.api.client.util.GenericData
  - - com.google.api.client.json.GenericJson
    - - com.google.api.services.servicenetworking.v1beta.model.BackendRule

All Implemented Interfaces:

Cloneable, Map<String,Object>
```
public final class BackendRule
extends com.google.api.client.json.GenericJson
```
A backend rule provides configuration for an individual API element.
This is the Java data model class that specifies how to parse/serialize into the JSON that is transmitted over HTTP when working with the Service Networking API. For a detailed explanation see: https://developers.google.com/api-client-library/java/google-http-java-client/json

Author:

Google, Inc.

Nested Class Summary
- Nested classes/interfaces inherited from class com.google.api.client.util.GenericData
  com.google.api.client.util.GenericData.Flags
- Nested classes/interfaces inherited from class java.util.AbstractMap
  AbstractMap.SimpleEntry<K,V>, AbstractMap.SimpleImmutableEntry<K,V>
- Nested classes/interfaces inherited from interface java.util.Map
  Map.Entry<K,V>

Constructor Summary

Constructors
Constructor and Description

BackendRule()

Constructors
Constructor and Description
`BackendRule()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`BackendRule`	`clone()`
`String`	`getAddress()` The address of the API backend.
`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.
`Double`	`getMinDeadline()` Deprecated, do not use.
`Double`	`getOperationDeadline()` The number of seconds to wait for the completion of a long running operation.
`Map<String,BackendRule>`	`getOverridesByRequestProtocol()` The map between request protocol and the backend address.
`String`	`getPathTranslation()`
`String`	`getProtocol()` The protocol used for sending a request to the backend.
`String`	`getSelector()` Selects the methods to which this rule applies.
`BackendRule`	`set(String fieldName, Object value)`
`BackendRule`	`setAddress(String address)` The address of the API backend.
`BackendRule`	`setDeadline(Double deadline)` The number of seconds to wait for a response from a request.
`BackendRule`	`setDisableAuth(Boolean disableAuth)` When disable_auth is true, a JWT ID token won't be generated and the original "Authorization" HTTP header will be preserved.
`BackendRule`	`setJwtAudience(String jwtAudience)` The JWT audience is used when generating a JWT ID token for the backend.
`BackendRule`	`setMinDeadline(Double minDeadline)` Deprecated, do not use.
`BackendRule`	`setOperationDeadline(Double operationDeadline)` The number of seconds to wait for the completion of a long running operation.
`BackendRule`	`setOverridesByRequestProtocol(Map<String,BackendRule> overridesByRequestProtocol)` The map between request protocol and the backend address.
`BackendRule`	`setPathTranslation(String pathTranslation)`
`BackendRule`	`setProtocol(String protocol)` The protocol used for sending a request to the backend.
`BackendRule`	`setSelector(String selector)` Selects the methods to which this rule applies.

Methods inherited from class com.google.api.client.json.GenericJson
getFactory, setFactory, toPrettyString, toString

Methods inherited from class com.google.api.client.util.GenericData
entrySet, equals, get, getClassInfo, getUnknownKeys, hashCode, put, putAll, remove, setUnknownKeys

Methods inherited from class java.util.AbstractMap
clear, containsKey, containsValue, isEmpty, keySet, size, values

Methods inherited from class java.lang.Object
finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface java.util.Map
compute, computeIfAbsent, computeIfPresent, forEach, getOrDefault, merge, putIfAbsent, remove, replace, replace, replaceAll

- Constructor Detail
  - BackendRule
```
public BackendRule()
```
- Method Detail
  - getAddress
```
public 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 to specify the protocol version.
    
    Returns:
    
    value or null for none
  - setAddress
```
public BackendRule setAddress(String 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.
    
    Parameters:
    
    address - address or null for none
  - getDeadline
```
public 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.
    
    Returns:
    
    value or null for none
  - setDeadline
```
public BackendRule setDeadline(Double deadline)
```
    The number of seconds to wait for a response from a request. The default varies based on the request protocol and deployment environment.
    
    Parameters:
    
    deadline - deadline or null for none
  - getDisableAuth
```
public 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.
    
    Returns:
    
    value or null for none
  - setDisableAuth
```
public BackendRule setDisableAuth(Boolean 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.
    
    Parameters:
    
    disableAuth - disableAuth or null for none
  - getJwtAudience
```
public 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.
    
    Returns:
    
    value or null for none
  - setJwtAudience
```
public BackendRule setJwtAudience(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.
    
    Parameters:
    
    jwtAudience - jwtAudience or null for none
  - getMinDeadline
```
public Double getMinDeadline()
```
    Deprecated, do not use.
    
    Returns:
    
    value or null for none
  - setMinDeadline
```
public BackendRule setMinDeadline(Double minDeadline)
```
    Deprecated, do not use.
    
    Parameters:
    
    minDeadline - minDeadline or null for none
  - getOperationDeadline
```
public Double getOperationDeadline()
```
    The number of seconds to wait for the completion of a long running operation. The default is no deadline.
    
    Returns:
    
    value or null for none
  - setOperationDeadline
```
public BackendRule setOperationDeadline(Double operationDeadline)
```
    The number of seconds to wait for the completion of a long running operation. The default is no deadline.
    
    Parameters:
    
    operationDeadline - operationDeadline or null for none
  - getOverridesByRequestProtocol
```
public Map<String,BackendRule> getOverridesByRequestProtocol()
```
    The map between request protocol and the backend address.
    
    Returns:
    
    value or null for none
  - setOverridesByRequestProtocol
```
public BackendRule setOverridesByRequestProtocol(Map<String,BackendRule> overridesByRequestProtocol)
```
    The map between request protocol and the backend address.
    
    Parameters:
    
    overridesByRequestProtocol - overridesByRequestProtocol or null for none
  - getPathTranslation
```
public String getPathTranslation()
```
    Returns:
    
    value or null for none
  - setPathTranslation
```
public BackendRule setPathTranslation(String pathTranslation)
```
    Parameters:
    
    pathTranslation - pathTranslation or null for none
  - getProtocol
```
public 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 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:
    
    value or null for none
  - setProtocol
```
public BackendRule setProtocol(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.
    
    Parameters:
    
    protocol - protocol or null for none
  - getSelector
```
public String getSelector()
```
    Selects the methods to which this rule applies. Refer to selector for syntax details.
    
    Returns:
    
    value or null for none
  - setSelector
```
public BackendRule setSelector(String selector)
```
    Selects the methods to which this rule applies. Refer to selector for syntax details.
    
    Parameters:
    
    selector - selector or null for none
  - set
```
public BackendRule set(String fieldName,
                       Object value)
```
    Overrides:
    
    set in class com.google.api.client.json.GenericJson
  - clone
```
public BackendRule clone()
```
    Overrides:
    
    clone in class com.google.api.client.json.GenericJson

Class BackendRule

Nested Class Summary

Nested classes/interfaces inherited from class com.google.api.client.util.GenericData

Nested classes/interfaces inherited from class java.util.AbstractMap

Nested classes/interfaces inherited from interface java.util.Map

Constructor Summary

Method Summary

Methods inherited from class com.google.api.client.json.GenericJson

Methods inherited from class com.google.api.client.util.GenericData

Methods inherited from class java.util.AbstractMap

Methods inherited from class java.lang.Object

Methods inherited from interface java.util.Map

Constructor Detail

BackendRule

Method Detail

getAddress

setAddress

getDeadline

setDeadline

getDisableAuth

setDisableAuth

getJwtAudience

setJwtAudience

getMinDeadline

setMinDeadline

getOperationDeadline

setOperationDeadline

getOverridesByRequestProtocol

setOverridesByRequestProtocol

getPathTranslation

setPathTranslation

getProtocol

setProtocol

getSelector

setSelector

set

clone