public static final class BackendRule.Builder extends com.google.protobuf.GeneratedMessageV3.Builder<BackendRule.Builder> implements BackendRuleOrBuilder
A backend rule provides configuration for an individual API element.Protobuf type
google.api.BackendRule| Modifier and Type | Method and Description |
|---|---|
BackendRule.Builder |
addRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field,
Object value) |
BackendRule |
build() |
BackendRule |
buildPartial() |
BackendRule.Builder |
clear() |
BackendRule.Builder |
clearAddress()
The address of the API backend.
|
BackendRule.Builder |
clearAuthentication() |
BackendRule.Builder |
clearDeadline()
The number of seconds to wait for a response from a request.
|
BackendRule.Builder |
clearDisableAuth()
When disable_auth is true, a JWT ID token won't be generated and the
original "Authorization" HTTP header will be preserved.
|
BackendRule.Builder |
clearField(com.google.protobuf.Descriptors.FieldDescriptor field) |
BackendRule.Builder |
clearJwtAudience()
The JWT audience is used when generating a JWT ID token for the backend.
|
BackendRule.Builder |
clearMinDeadline()
Minimum deadline in seconds needed for this method.
|
BackendRule.Builder |
clearOneof(com.google.protobuf.Descriptors.OneofDescriptor oneof) |
BackendRule.Builder |
clearOperationDeadline()
The number of seconds to wait for the completion of a long running
operation.
|
BackendRule.Builder |
clearPathTranslation()
.google.api.BackendRule.PathTranslation path_translation = 6; |
BackendRule.Builder |
clearProtocol()
The protocol used for sending a request to the backend.
|
BackendRule.Builder |
clearSelector()
Selects the methods to which this rule applies.
|
BackendRule.Builder |
clone() |
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.
|
BackendRule |
getDefaultInstanceForType() |
static com.google.protobuf.Descriptors.Descriptor |
getDescriptor() |
com.google.protobuf.Descriptors.Descriptor |
getDescriptorForType() |
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.
|
protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable |
internalGetFieldAccessorTable() |
boolean |
isInitialized() |
BackendRule.Builder |
mergeFrom(BackendRule other) |
BackendRule.Builder |
mergeFrom(com.google.protobuf.CodedInputStream input,
com.google.protobuf.ExtensionRegistryLite extensionRegistry) |
BackendRule.Builder |
mergeFrom(com.google.protobuf.Message other) |
BackendRule.Builder |
mergeUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields) |
BackendRule.Builder |
setAddress(String value)
The address of the API backend.
|
BackendRule.Builder |
setAddressBytes(com.google.protobuf.ByteString value)
The address of the API backend.
|
BackendRule.Builder |
setDeadline(double value)
The number of seconds to wait for a response from a request.
|
BackendRule.Builder |
setDisableAuth(boolean value)
When disable_auth is true, a JWT ID token won't be generated and the
original "Authorization" HTTP header will be preserved.
|
BackendRule.Builder |
setField(com.google.protobuf.Descriptors.FieldDescriptor field,
Object value) |
BackendRule.Builder |
setJwtAudience(String value)
The JWT audience is used when generating a JWT ID token for the backend.
|
BackendRule.Builder |
setJwtAudienceBytes(com.google.protobuf.ByteString value)
The JWT audience is used when generating a JWT ID token for the backend.
|
BackendRule.Builder |
setMinDeadline(double value)
Minimum deadline in seconds needed for this method.
|
BackendRule.Builder |
setOperationDeadline(double value)
The number of seconds to wait for the completion of a long running
operation.
|
BackendRule.Builder |
setPathTranslation(BackendRule.PathTranslation value)
.google.api.BackendRule.PathTranslation path_translation = 6; |
BackendRule.Builder |
setPathTranslationValue(int value)
.google.api.BackendRule.PathTranslation path_translation = 6; |
BackendRule.Builder |
setProtocol(String value)
The protocol used for sending a request to the backend.
|
BackendRule.Builder |
setProtocolBytes(com.google.protobuf.ByteString value)
The protocol used for sending a request to the backend.
|
BackendRule.Builder |
setRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field,
int index,
Object value) |
BackendRule.Builder |
setSelector(String value)
Selects the methods to which this rule applies.
|
BackendRule.Builder |
setSelectorBytes(com.google.protobuf.ByteString value)
Selects the methods to which this rule applies.
|
BackendRule.Builder |
setUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields) |
getAllFields, getField, getFieldBuilder, getOneofFieldDescriptor, getParentForChildren, getRepeatedField, getRepeatedFieldBuilder, getRepeatedFieldCount, getUnknownFields, getUnknownFieldSetBuilder, hasField, hasOneof, internalGetMapField, internalGetMutableMapField, isClean, markClean, mergeUnknownLengthDelimitedField, mergeUnknownVarintField, newBuilderForField, onBuilt, onChanged, parseUnknownField, setUnknownFieldSetBuilder, setUnknownFieldsProto3findInitializationErrors, getInitializationErrorString, internalMergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, newUninitializedMessageException, toStringaddAll, addAll, mergeDelimitedFrom, mergeDelimitedFrom, mergeFrom, newUninitializedMessageExceptionequals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, waitfindInitializationErrors, getAllFields, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneofpublic static final com.google.protobuf.Descriptors.Descriptor getDescriptor()
protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessageV3.Builder<BackendRule.Builder>public BackendRule.Builder clear()
clear in interface com.google.protobuf.Message.Builderclear in interface com.google.protobuf.MessageLite.Builderclear in class com.google.protobuf.GeneratedMessageV3.Builder<BackendRule.Builder>public com.google.protobuf.Descriptors.Descriptor getDescriptorForType()
getDescriptorForType in interface com.google.protobuf.Message.BuildergetDescriptorForType in interface com.google.protobuf.MessageOrBuildergetDescriptorForType in class com.google.protobuf.GeneratedMessageV3.Builder<BackendRule.Builder>public BackendRule getDefaultInstanceForType()
getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuildergetDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilderpublic BackendRule build()
build in interface com.google.protobuf.Message.Builderbuild in interface com.google.protobuf.MessageLite.Builderpublic BackendRule buildPartial()
buildPartial in interface com.google.protobuf.Message.BuilderbuildPartial in interface com.google.protobuf.MessageLite.Builderpublic BackendRule.Builder clone()
clone in interface com.google.protobuf.Message.Builderclone in interface com.google.protobuf.MessageLite.Builderclone in class com.google.protobuf.GeneratedMessageV3.Builder<BackendRule.Builder>public BackendRule.Builder setField(com.google.protobuf.Descriptors.FieldDescriptor field, Object value)
setField in interface com.google.protobuf.Message.BuildersetField in class com.google.protobuf.GeneratedMessageV3.Builder<BackendRule.Builder>public BackendRule.Builder clearField(com.google.protobuf.Descriptors.FieldDescriptor field)
clearField in interface com.google.protobuf.Message.BuilderclearField in class com.google.protobuf.GeneratedMessageV3.Builder<BackendRule.Builder>public BackendRule.Builder clearOneof(com.google.protobuf.Descriptors.OneofDescriptor oneof)
clearOneof in interface com.google.protobuf.Message.BuilderclearOneof in class com.google.protobuf.GeneratedMessageV3.Builder<BackendRule.Builder>public BackendRule.Builder setRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field, int index, Object value)
setRepeatedField in interface com.google.protobuf.Message.BuildersetRepeatedField in class com.google.protobuf.GeneratedMessageV3.Builder<BackendRule.Builder>public BackendRule.Builder addRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field, Object value)
addRepeatedField in interface com.google.protobuf.Message.BuilderaddRepeatedField in class com.google.protobuf.GeneratedMessageV3.Builder<BackendRule.Builder>public BackendRule.Builder mergeFrom(com.google.protobuf.Message other)
mergeFrom in interface com.google.protobuf.Message.BuildermergeFrom in class com.google.protobuf.AbstractMessage.Builder<BackendRule.Builder>public BackendRule.Builder mergeFrom(BackendRule other)
public final boolean isInitialized()
isInitialized in interface com.google.protobuf.MessageLiteOrBuilderisInitialized in class com.google.protobuf.GeneratedMessageV3.Builder<BackendRule.Builder>public BackendRule.Builder mergeFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
mergeFrom in interface com.google.protobuf.Message.BuildermergeFrom in interface com.google.protobuf.MessageLite.BuildermergeFrom in class com.google.protobuf.AbstractMessage.Builder<BackendRule.Builder>IOExceptionpublic BackendRule.AuthenticationCase getAuthenticationCase()
getAuthenticationCase in interface BackendRuleOrBuilderpublic BackendRule.Builder clearAuthentication()
public String getSelector()
Selects the methods to which this rule applies. Refer to [selector][google.api.DocumentationRule.selector] for syntax details.
string selector = 1;getSelector in interface BackendRuleOrBuilderpublic 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;getSelectorBytes in interface BackendRuleOrBuilderpublic BackendRule.Builder setSelector(String value)
Selects the methods to which this rule applies. Refer to [selector][google.api.DocumentationRule.selector] for syntax details.
string selector = 1;value - The selector to set.public BackendRule.Builder clearSelector()
Selects the methods to which this rule applies. Refer to [selector][google.api.DocumentationRule.selector] for syntax details.
string selector = 1;public BackendRule.Builder setSelectorBytes(com.google.protobuf.ByteString value)
Selects the methods to which this rule applies. Refer to [selector][google.api.DocumentationRule.selector] for syntax details.
string selector = 1;value - The bytes for selector to set.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][google.api.BackendRule.protocol]
to specify the protocol version.
string address = 2;getAddress in interface BackendRuleOrBuilderpublic 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;getAddressBytes in interface BackendRuleOrBuilderpublic BackendRule.Builder setAddress(String value)
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;value - The address to set.public BackendRule.Builder clearAddress()
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;public BackendRule.Builder setAddressBytes(com.google.protobuf.ByteString value)
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;value - The bytes for address to set.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;getDeadline in interface BackendRuleOrBuilderpublic BackendRule.Builder setDeadline(double value)
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;value - The deadline to set.public BackendRule.Builder clearDeadline()
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;public double getMinDeadline()
Minimum deadline in seconds needed for this method. Calls having deadline value lower than this will be rejected.
double min_deadline = 4;getMinDeadline in interface BackendRuleOrBuilderpublic BackendRule.Builder setMinDeadline(double value)
Minimum deadline in seconds needed for this method. Calls having deadline value lower than this will be rejected.
double min_deadline = 4;value - The minDeadline to set.public BackendRule.Builder clearMinDeadline()
Minimum deadline in seconds needed for this method. Calls having deadline value lower than this will be rejected.
double min_deadline = 4;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;getOperationDeadline in interface BackendRuleOrBuilderpublic BackendRule.Builder setOperationDeadline(double value)
The number of seconds to wait for the completion of a long running operation. The default is no deadline.
double operation_deadline = 5;value - The operationDeadline to set.public BackendRule.Builder clearOperationDeadline()
The number of seconds to wait for the completion of a long running operation. The default is no deadline.
double operation_deadline = 5;public int getPathTranslationValue()
.google.api.BackendRule.PathTranslation path_translation = 6;getPathTranslationValue in interface BackendRuleOrBuilderpublic BackendRule.Builder setPathTranslationValue(int value)
.google.api.BackendRule.PathTranslation path_translation = 6;value - The enum numeric value on the wire for pathTranslation to set.public BackendRule.PathTranslation getPathTranslation()
.google.api.BackendRule.PathTranslation path_translation = 6;getPathTranslation in interface BackendRuleOrBuilderpublic BackendRule.Builder setPathTranslation(BackendRule.PathTranslation value)
.google.api.BackendRule.PathTranslation path_translation = 6;value - The pathTranslation to set.public BackendRule.Builder clearPathTranslation()
.google.api.BackendRule.PathTranslation path_translation = 6;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;hasJwtAudience in interface BackendRuleOrBuilderpublic 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;getJwtAudience in interface BackendRuleOrBuilderpublic 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;getJwtAudienceBytes in interface BackendRuleOrBuilderpublic BackendRule.Builder setJwtAudience(String value)
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;value - The jwtAudience to set.public BackendRule.Builder clearJwtAudience()
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;public BackendRule.Builder setJwtAudienceBytes(com.google.protobuf.ByteString value)
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;value - The bytes for jwtAudience to set.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;hasDisableAuth in interface BackendRuleOrBuilderpublic 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;getDisableAuth in interface BackendRuleOrBuilderpublic BackendRule.Builder setDisableAuth(boolean value)
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;value - The disableAuth to set.public BackendRule.Builder clearDisableAuth()
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;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][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;getProtocol in interface BackendRuleOrBuilderpublic 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;getProtocolBytes in interface BackendRuleOrBuilderpublic BackendRule.Builder setProtocol(String value)
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;value - The protocol to set.public BackendRule.Builder clearProtocol()
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;public BackendRule.Builder setProtocolBytes(com.google.protobuf.ByteString value)
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;value - The bytes for protocol to set.public final BackendRule.Builder setUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields)
setUnknownFields in interface com.google.protobuf.Message.BuildersetUnknownFields in class com.google.protobuf.GeneratedMessageV3.Builder<BackendRule.Builder>public final BackendRule.Builder mergeUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields)
mergeUnknownFields in interface com.google.protobuf.Message.BuildermergeUnknownFields in class com.google.protobuf.GeneratedMessageV3.Builder<BackendRule.Builder>Copyright © 2022 Google LLC. All rights reserved.