public final class BackendRule extends GeneratedMessageV3 implements BackendRuleOrBuilder
A backend rule provides configuration for an individual API element.
Protobuf type google.api.BackendRule
Inherited Members
com.google.protobuf.GeneratedMessageV3.<ListT>makeMutableCopy(ListT)
Static Fields
ADDRESS_FIELD_NUMBER
public static final int ADDRESS_FIELD_NUMBER
| Field Value |
|---|
| Type | Description |
int | |
DEADLINE_FIELD_NUMBER
public static final int DEADLINE_FIELD_NUMBER
| Field Value |
|---|
| Type | Description |
int | |
DISABLE_AUTH_FIELD_NUMBER
public static final int DISABLE_AUTH_FIELD_NUMBER
| Field Value |
|---|
| Type | Description |
int | |
JWT_AUDIENCE_FIELD_NUMBER
public static final int JWT_AUDIENCE_FIELD_NUMBER
| Field Value |
|---|
| Type | Description |
int | |
MIN_DEADLINE_FIELD_NUMBER
public static final int MIN_DEADLINE_FIELD_NUMBER
| Field Value |
|---|
| Type | Description |
int | |
OPERATION_DEADLINE_FIELD_NUMBER
public static final int OPERATION_DEADLINE_FIELD_NUMBER
| Field Value |
|---|
| Type | Description |
int | |
OVERRIDES_BY_REQUEST_PROTOCOL_FIELD_NUMBER
public static final int OVERRIDES_BY_REQUEST_PROTOCOL_FIELD_NUMBER
| Field Value |
|---|
| Type | Description |
int | |
PATH_TRANSLATION_FIELD_NUMBER
public static final int PATH_TRANSLATION_FIELD_NUMBER
| Field Value |
|---|
| Type | Description |
int | |
PROTOCOL_FIELD_NUMBER
public static final int PROTOCOL_FIELD_NUMBER
| Field Value |
|---|
| Type | Description |
int | |
SELECTOR_FIELD_NUMBER
public static final int SELECTOR_FIELD_NUMBER
| Field Value |
|---|
| Type | Description |
int | |
Static Methods
getDefaultInstance()
public static BackendRule getDefaultInstance()
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()
newBuilder()
public static BackendRule.Builder newBuilder()
newBuilder(BackendRule prototype)
public static BackendRule.Builder newBuilder(BackendRule prototype)
public static BackendRule parseDelimitedFrom(InputStream input)
public static BackendRule parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
parseFrom(byte[] data)
public static BackendRule parseFrom(byte[] data)
| Parameter |
|---|
| Name | Description |
data | byte[]
|
parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
public static BackendRule parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
parseFrom(ByteString data)
public static BackendRule parseFrom(ByteString data)
parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static BackendRule parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static BackendRule parseFrom(CodedInputStream input)
public static BackendRule parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
public static BackendRule parseFrom(InputStream input)
public static BackendRule parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
parseFrom(ByteBuffer data)
public static BackendRule parseFrom(ByteBuffer data)
parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
public static BackendRule parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
parser()
public static Parser<BackendRule> parser()
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 |
|---|
| Name | Description |
key | String
|
equals(Object obj)
public boolean equals(Object obj)
| Parameter |
|---|
| Name | Description |
obj | Object
|
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:
string address = 2;
| Returns |
|---|
| Type | Description |
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:
string address = 2;
| Returns |
|---|
| Type | Description |
ByteString | The bytes for address.
|
getAuthenticationCase()
public BackendRule.AuthenticationCase getAuthenticationCase()
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 |
|---|
| Type | Description |
double | The deadline.
|
getDefaultInstanceForType()
public BackendRule getDefaultInstanceForType()
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 |
|---|
| Type | Description |
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 |
|---|
| Type | Description |
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 |
|---|
| Type | Description |
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 |
|---|
| Type | Description |
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 |
|---|
| Type | Description |
double | The operationDeadline.
|
getOverridesByRequestProtocol()
public Map<String,BackendRule> getOverridesByRequestProtocol()
getOverridesByRequestProtocolCount()
public int getOverridesByRequestProtocolCount()
The map between request protocol and the backend address.
map<string, .google.api.BackendRule> overrides_by_request_protocol = 10;
| Returns |
|---|
| Type | Description |
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;
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;
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 |
|---|
| Name | Description |
key | String
|
getParserForType()
public Parser<BackendRule> getParserForType()
Overrides
getPathTranslation()
public BackendRule.PathTranslation getPathTranslation()
.google.api.BackendRule.PathTranslation path_translation = 6;
getPathTranslationValue()
public int getPathTranslationValue()
.google.api.BackendRule.PathTranslation path_translation = 6;
| Returns |
|---|
| Type | Description |
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 |
|---|
| Type | Description |
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 |
|---|
| Type | Description |
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 |
|---|
| Type | Description |
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 |
|---|
| Type | Description |
ByteString | The bytes for selector.
|
getSerializedSize()
public int getSerializedSize()
| Returns |
|---|
| Type | Description |
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 |
|---|
| Type | Description |
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 |
|---|
| Type | Description |
boolean | Whether the jwtAudience field is set.
|
hashCode()
| Returns |
|---|
| Type | Description |
int | |
Overrides
internalGetFieldAccessorTable()
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Overrides
internalGetMapField(int number)
protected MapField internalGetMapField(int number)
| Parameter |
|---|
| Name | Description |
number | int
|
Overrides
isInitialized()
public final boolean isInitialized()
Overrides
newBuilderForType()
public BackendRule.Builder newBuilderForType()
newBuilderForType(GeneratedMessageV3.BuilderParent parent)
protected BackendRule.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Overrides
newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Overrides
toBuilder()
public BackendRule.Builder toBuilder()
writeTo(CodedOutputStream output)
public void writeTo(CodedOutputStream output)
Overrides
