Class BackendRule (2.24.0)

public final class BackendRule extends GeneratedMessageV3 implements BackendRuleOrBuilder

A backend rule provides configuration for an individual API element.

Protobuf type google.api.BackendRule

Static Fields

ADDRESS_FIELD_NUMBER

public static final int ADDRESS_FIELD_NUMBER
Field Value
TypeDescription
int

DEADLINE_FIELD_NUMBER

public static final int DEADLINE_FIELD_NUMBER
Field Value
TypeDescription
int

DISABLE_AUTH_FIELD_NUMBER

public static final int DISABLE_AUTH_FIELD_NUMBER
Field Value
TypeDescription
int

JWT_AUDIENCE_FIELD_NUMBER

public static final int JWT_AUDIENCE_FIELD_NUMBER
Field Value
TypeDescription
int

MIN_DEADLINE_FIELD_NUMBER

public static final int MIN_DEADLINE_FIELD_NUMBER
Field Value
TypeDescription
int

OPERATION_DEADLINE_FIELD_NUMBER

public static final int OPERATION_DEADLINE_FIELD_NUMBER
Field Value
TypeDescription
int

OVERRIDES_BY_REQUEST_PROTOCOL_FIELD_NUMBER

public static final int OVERRIDES_BY_REQUEST_PROTOCOL_FIELD_NUMBER
Field Value
TypeDescription
int

PATH_TRANSLATION_FIELD_NUMBER

public static final int PATH_TRANSLATION_FIELD_NUMBER
Field Value
TypeDescription
int

PROTOCOL_FIELD_NUMBER

public static final int PROTOCOL_FIELD_NUMBER
Field Value
TypeDescription
int

SELECTOR_FIELD_NUMBER

public static final int SELECTOR_FIELD_NUMBER
Field Value
TypeDescription
int

Static Methods

getDefaultInstance()

public static BackendRule getDefaultInstance()
Returns
TypeDescription
BackendRule

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
TypeDescription
Descriptor

newBuilder()

public static BackendRule.Builder newBuilder()
Returns
TypeDescription
BackendRule.Builder

newBuilder(BackendRule prototype)

public static BackendRule.Builder newBuilder(BackendRule prototype)
Parameter
NameDescription
prototypeBackendRule
Returns
TypeDescription
BackendRule.Builder

parseDelimitedFrom(InputStream input)

public static BackendRule parseDelimitedFrom(InputStream input)
Parameter
NameDescription
inputInputStream
Returns
TypeDescription
BackendRule
Exceptions
TypeDescription
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static BackendRule parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
BackendRule
Exceptions
TypeDescription
IOException

parseFrom(byte[] data)

public static BackendRule parseFrom(byte[] data)
Parameter
NameDescription
databyte[]
Returns
TypeDescription
BackendRule
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static BackendRule parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
databyte[]
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
BackendRule
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteString data)

public static BackendRule parseFrom(ByteString data)
Parameter
NameDescription
dataByteString
Returns
TypeDescription
BackendRule
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static BackendRule parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
dataByteString
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
BackendRule
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static BackendRule parseFrom(CodedInputStream input)
Parameter
NameDescription
inputCodedInputStream
Returns
TypeDescription
BackendRule
Exceptions
TypeDescription
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static BackendRule parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputCodedInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
BackendRule
Exceptions
TypeDescription
IOException

parseFrom(InputStream input)

public static BackendRule parseFrom(InputStream input)
Parameter
NameDescription
inputInputStream
Returns
TypeDescription
BackendRule
Exceptions
TypeDescription
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static BackendRule parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
BackendRule
Exceptions
TypeDescription
IOException

parseFrom(ByteBuffer data)

public static BackendRule parseFrom(ByteBuffer data)
Parameter
NameDescription
dataByteBuffer
Returns
TypeDescription
BackendRule
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static BackendRule parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
dataByteBuffer
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
BackendRule
Exceptions
TypeDescription
InvalidProtocolBufferException

parser()

public static Parser<BackendRule> parser()
Returns
TypeDescription
Parser<BackendRule>

Methods

containsOverridesByRequestProtocol(String key)

public boolean containsOverridesByRequestProtocol(String key)

The map between request protocol and the backend address.

map<string, .google.api.BackendRule> overrides_by_request_protocol = 10;

Parameter
NameDescription
keyString
Returns
TypeDescription
boolean

equals(Object obj)

public boolean equals(Object obj)
Parameter
NameDescription
objObject
Returns
TypeDescription
boolean
Overrides

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.

string address = 2;

Returns
TypeDescription
String

The address.

getAddressBytes()

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

string address = 2;

Returns
TypeDescription
ByteString

The bytes for address.

getAuthenticationCase()

public BackendRule.AuthenticationCase getAuthenticationCase()
Returns
TypeDescription
BackendRule.AuthenticationCase

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.

double deadline = 3;

Returns
TypeDescription
double

The deadline.

getDefaultInstanceForType()

public BackendRule getDefaultInstanceForType()
Returns
TypeDescription
BackendRule

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.

bool disable_auth = 8;

Returns
TypeDescription
boolean

The disableAuth.

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.

string jwt_audience = 7;

Returns
TypeDescription
String

The jwtAudience.

getJwtAudienceBytes()

public 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
TypeDescription
ByteString

The bytes for jwtAudience.

getMinDeadline() (deprecated)

public 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
TypeDescription
double

The minDeadline.

getOperationDeadline()

public 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
TypeDescription
double

The operationDeadline.

getOverridesByRequestProtocol()

public Map<String,BackendRule> getOverridesByRequestProtocol()
Returns
TypeDescription
Map<String,BackendRule>

getOverridesByRequestProtocolCount()

public int getOverridesByRequestProtocolCount()

The map between request protocol and the backend address.

map<string, .google.api.BackendRule> overrides_by_request_protocol = 10;

Returns
TypeDescription
int

getOverridesByRequestProtocolMap()

public Map<String,BackendRule> getOverridesByRequestProtocolMap()

The map between request protocol and the backend address.

map<string, .google.api.BackendRule> overrides_by_request_protocol = 10;

Returns
TypeDescription
Map<String,BackendRule>

getOverridesByRequestProtocolOrDefault(String key, BackendRule defaultValue)

public 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;

Parameters
NameDescription
keyString
defaultValueBackendRule
Returns
TypeDescription
BackendRule

getOverridesByRequestProtocolOrThrow(String key)

public BackendRule getOverridesByRequestProtocolOrThrow(String key)

The map between request protocol and the backend address.

map<string, .google.api.BackendRule> overrides_by_request_protocol = 10;

Parameter
NameDescription
keyString
Returns
TypeDescription
BackendRule

getParserForType()

public Parser<BackendRule> getParserForType()
Returns
TypeDescription
Parser<BackendRule>
Overrides

getPathTranslation()

public BackendRule.PathTranslation getPathTranslation()

.google.api.BackendRule.PathTranslation path_translation = 6;

Returns
TypeDescription
BackendRule.PathTranslation

The pathTranslation.

getPathTranslationValue()

public int getPathTranslationValue()

.google.api.BackendRule.PathTranslation path_translation = 6;

Returns
TypeDescription
int

The enum numeric value on the wire for pathTranslation.

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.

string protocol = 9;

Returns
TypeDescription
String

The protocol.

getProtocolBytes()

public 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 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
TypeDescription
ByteString

The bytes for protocol.

getSelector()

public String getSelector()

Selects the methods to which this rule applies.

Refer to selector for syntax details.

string selector = 1;

Returns
TypeDescription
String

The selector.

getSelectorBytes()

public ByteString getSelectorBytes()

Selects the methods to which this rule applies.

Refer to selector for syntax details.

string selector = 1;

Returns
TypeDescription
ByteString

The bytes for selector.

getSerializedSize()

public int getSerializedSize()
Returns
TypeDescription
int
Overrides

hasDisableAuth()

public 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
TypeDescription
boolean

Whether the disableAuth field is set.

hasJwtAudience()

public 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
TypeDescription
boolean

Whether the jwtAudience field is set.

hashCode()

public int hashCode()
Returns
TypeDescription
int
Overrides

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
TypeDescription
FieldAccessorTable
Overrides

internalGetMapField(int number)

protected MapField internalGetMapField(int number)
Parameter
NameDescription
numberint
Returns
TypeDescription
MapField
Overrides

isInitialized()

public final boolean isInitialized()
Returns
TypeDescription
boolean
Overrides

newBuilderForType()

public BackendRule.Builder newBuilderForType()
Returns
TypeDescription
BackendRule.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected BackendRule.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
NameDescription
parentBuilderParent
Returns
TypeDescription
BackendRule.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
NameDescription
unusedUnusedPrivateParameter
Returns
TypeDescription
Object
Overrides

toBuilder()

public BackendRule.Builder toBuilder()
Returns
TypeDescription
BackendRule.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
NameDescription
outputCodedOutputStream
Overrides
Exceptions
TypeDescription
IOException