public final class BackendService extends com.google.protobuf.GeneratedMessageV3 implements BackendServiceOrBuilder
Represents a Backend Service resource. A backend service defines how Google Cloud load balancers distribute traffic. The backend service configuration contains a set of values, such as the protocol used to connect to backends, various distribution and session settings, health checks, and timeouts. These settings provide fine-grained control over how your load balancer behaves. Most of the settings have default values that allow for easy configuration if you need to get started quickly. Backend services in Google Compute Engine can be either regionally or globally scoped. * [Global](https://cloud.google.com/compute/docs/reference/rest/v1/backendServices) * [Regional](https://cloud.google.com/compute/docs/reference/rest/v1/regionBackendServices) For more information, see Backend Services.Protobuf type
google.cloud.compute.v1.BackendService| Modifier and Type | Class and Description |
|---|---|
static class |
BackendService.Builder
Represents a Backend Service resource.
|
static class |
BackendService.CompressionMode
Compress text responses using Brotli or gzip compression, based on the client's Accept-Encoding header.
|
static class |
BackendService.LoadBalancingScheme
Specifies the load balancer type.
|
static class |
BackendService.LocalityLbPolicy
The load balancing algorithm used within the scope of the locality.
|
static class |
BackendService.Protocol
The protocol this BackendService uses to communicate with backends.
|
static class |
BackendService.SessionAffinity
Type of session affinity to use.
|
com.google.protobuf.GeneratedMessageV3.BuilderParent, com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageType extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage,BuilderType extends com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageType,BuilderType>>, com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageType extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage>, com.google.protobuf.GeneratedMessageV3.ExtendableMessageOrBuilder<MessageType extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage>, com.google.protobuf.GeneratedMessageV3.FieldAccessorTable, com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter| Modifier and Type | Method and Description |
|---|---|
boolean |
equals(Object obj) |
int |
getAffinityCookieTtlSec()
Lifetime of cookies in seconds.
|
Backend |
getBackends(int index)
The list of backends that serve this BackendService.
|
int |
getBackendsCount()
The list of backends that serve this BackendService.
|
List<Backend> |
getBackendsList()
The list of backends that serve this BackendService.
|
BackendOrBuilder |
getBackendsOrBuilder(int index)
The list of backends that serve this BackendService.
|
List<? extends BackendOrBuilder> |
getBackendsOrBuilderList()
The list of backends that serve this BackendService.
|
BackendServiceCdnPolicy |
getCdnPolicy()
Cloud CDN configuration for this BackendService.
|
BackendServiceCdnPolicyOrBuilder |
getCdnPolicyOrBuilder()
Cloud CDN configuration for this BackendService.
|
CircuitBreakers |
getCircuitBreakers()
optional .google.cloud.compute.v1.CircuitBreakers circuit_breakers = 421340061; |
CircuitBreakersOrBuilder |
getCircuitBreakersOrBuilder()
optional .google.cloud.compute.v1.CircuitBreakers circuit_breakers = 421340061; |
String |
getCompressionMode()
Compress text responses using Brotli or gzip compression, based on the client's Accept-Encoding header.
|
com.google.protobuf.ByteString |
getCompressionModeBytes()
Compress text responses using Brotli or gzip compression, based on the client's Accept-Encoding header.
|
ConnectionDraining |
getConnectionDraining()
optional .google.cloud.compute.v1.ConnectionDraining connection_draining = 461096747;
|
ConnectionDrainingOrBuilder |
getConnectionDrainingOrBuilder()
optional .google.cloud.compute.v1.ConnectionDraining connection_draining = 461096747;
|
BackendServiceConnectionTrackingPolicy |
getConnectionTrackingPolicy()
Connection Tracking configuration for this BackendService.
|
BackendServiceConnectionTrackingPolicyOrBuilder |
getConnectionTrackingPolicyOrBuilder()
Connection Tracking configuration for this BackendService.
|
ConsistentHashLoadBalancerSettings |
getConsistentHash()
Consistent Hash-based load balancing can be used to provide soft session affinity based on HTTP headers, cookies or other properties.
|
ConsistentHashLoadBalancerSettingsOrBuilder |
getConsistentHashOrBuilder()
Consistent Hash-based load balancing can be used to provide soft session affinity based on HTTP headers, cookies or other properties.
|
String |
getCreationTimestamp()
[Output Only] Creation timestamp in RFC3339 text format.
|
com.google.protobuf.ByteString |
getCreationTimestampBytes()
[Output Only] Creation timestamp in RFC3339 text format.
|
String |
getCustomRequestHeaders(int index)
Headers that the load balancer adds to proxied requests.
|
com.google.protobuf.ByteString |
getCustomRequestHeadersBytes(int index)
Headers that the load balancer adds to proxied requests.
|
int |
getCustomRequestHeadersCount()
Headers that the load balancer adds to proxied requests.
|
com.google.protobuf.ProtocolStringList |
getCustomRequestHeadersList()
Headers that the load balancer adds to proxied requests.
|
String |
getCustomResponseHeaders(int index)
Headers that the load balancer adds to proxied responses.
|
com.google.protobuf.ByteString |
getCustomResponseHeadersBytes(int index)
Headers that the load balancer adds to proxied responses.
|
int |
getCustomResponseHeadersCount()
Headers that the load balancer adds to proxied responses.
|
com.google.protobuf.ProtocolStringList |
getCustomResponseHeadersList()
Headers that the load balancer adds to proxied responses.
|
static BackendService |
getDefaultInstance() |
BackendService |
getDefaultInstanceForType() |
String |
getDescription()
An optional description of this resource.
|
com.google.protobuf.ByteString |
getDescriptionBytes()
An optional description of this resource.
|
static com.google.protobuf.Descriptors.Descriptor |
getDescriptor() |
String |
getEdgeSecurityPolicy()
[Output Only] The resource URL for the edge security policy associated with this backend service.
|
com.google.protobuf.ByteString |
getEdgeSecurityPolicyBytes()
[Output Only] The resource URL for the edge security policy associated with this backend service.
|
boolean |
getEnableCDN()
If true, enables Cloud CDN for the backend service of an external HTTP(S) load balancer.
|
BackendServiceFailoverPolicy |
getFailoverPolicy()
Requires at least one backend instance group to be defined as a backup (failover) backend.
|
BackendServiceFailoverPolicyOrBuilder |
getFailoverPolicyOrBuilder()
Requires at least one backend instance group to be defined as a backup (failover) backend.
|
String |
getFingerprint()
Fingerprint of this resource.
|
com.google.protobuf.ByteString |
getFingerprintBytes()
Fingerprint of this resource.
|
String |
getHealthChecks(int index)
The list of URLs to the healthChecks, httpHealthChecks (legacy), or httpsHealthChecks (legacy) resource for health checking this backend service.
|
com.google.protobuf.ByteString |
getHealthChecksBytes(int index)
The list of URLs to the healthChecks, httpHealthChecks (legacy), or httpsHealthChecks (legacy) resource for health checking this backend service.
|
int |
getHealthChecksCount()
The list of URLs to the healthChecks, httpHealthChecks (legacy), or httpsHealthChecks (legacy) resource for health checking this backend service.
|
com.google.protobuf.ProtocolStringList |
getHealthChecksList()
The list of URLs to the healthChecks, httpHealthChecks (legacy), or httpsHealthChecks (legacy) resource for health checking this backend service.
|
BackendServiceIAP |
getIap()
The configurations for Identity-Aware Proxy on this resource.
|
BackendServiceIAPOrBuilder |
getIapOrBuilder()
The configurations for Identity-Aware Proxy on this resource.
|
long |
getId()
[Output Only] The unique identifier for the resource.
|
String |
getKind()
[Output Only] Type of resource.
|
com.google.protobuf.ByteString |
getKindBytes()
[Output Only] Type of resource.
|
String |
getLoadBalancingScheme()
Specifies the load balancer type.
|
com.google.protobuf.ByteString |
getLoadBalancingSchemeBytes()
Specifies the load balancer type.
|
BackendServiceLocalityLoadBalancingPolicyConfig |
getLocalityLbPolicies(int index)
A list of locality load balancing policies to be used in order of preference.
|
int |
getLocalityLbPoliciesCount()
A list of locality load balancing policies to be used in order of preference.
|
List<BackendServiceLocalityLoadBalancingPolicyConfig> |
getLocalityLbPoliciesList()
A list of locality load balancing policies to be used in order of preference.
|
BackendServiceLocalityLoadBalancingPolicyConfigOrBuilder |
getLocalityLbPoliciesOrBuilder(int index)
A list of locality load balancing policies to be used in order of preference.
|
List<? extends BackendServiceLocalityLoadBalancingPolicyConfigOrBuilder> |
getLocalityLbPoliciesOrBuilderList()
A list of locality load balancing policies to be used in order of preference.
|
String |
getLocalityLbPolicy()
The load balancing algorithm used within the scope of the locality.
|
com.google.protobuf.ByteString |
getLocalityLbPolicyBytes()
The load balancing algorithm used within the scope of the locality.
|
BackendServiceLogConfig |
getLogConfig()
This field denotes the logging options for the load balancer traffic served by this backend service.
|
BackendServiceLogConfigOrBuilder |
getLogConfigOrBuilder()
This field denotes the logging options for the load balancer traffic served by this backend service.
|
Duration |
getMaxStreamDuration()
Specifies the default maximum duration (timeout) for streams to this service.
|
DurationOrBuilder |
getMaxStreamDurationOrBuilder()
Specifies the default maximum duration (timeout) for streams to this service.
|
String |
getName()
Name of the resource.
|
com.google.protobuf.ByteString |
getNameBytes()
Name of the resource.
|
String |
getNetwork()
The URL of the network to which this backend service belongs.
|
com.google.protobuf.ByteString |
getNetworkBytes()
The URL of the network to which this backend service belongs.
|
OutlierDetection |
getOutlierDetection()
Settings controlling the eviction of unhealthy hosts from the load balancing pool for the backend service.
|
OutlierDetectionOrBuilder |
getOutlierDetectionOrBuilder()
Settings controlling the eviction of unhealthy hosts from the load balancing pool for the backend service.
|
com.google.protobuf.Parser<BackendService> |
getParserForType() |
int |
getPort()
Deprecated in favor of portName.
|
String |
getPortName()
A named port on a backend instance group representing the port for communication to the backend VMs in that group.
|
com.google.protobuf.ByteString |
getPortNameBytes()
A named port on a backend instance group representing the port for communication to the backend VMs in that group.
|
String |
getProtocol()
The protocol this BackendService uses to communicate with backends.
|
com.google.protobuf.ByteString |
getProtocolBytes()
The protocol this BackendService uses to communicate with backends.
|
String |
getRegion()
[Output Only] URL of the region where the regional backend service resides.
|
com.google.protobuf.ByteString |
getRegionBytes()
[Output Only] URL of the region where the regional backend service resides.
|
String |
getSecurityPolicy()
[Output Only] The resource URL for the security policy associated with this backend service.
|
com.google.protobuf.ByteString |
getSecurityPolicyBytes()
[Output Only] The resource URL for the security policy associated with this backend service.
|
SecuritySettings |
getSecuritySettings()
This field specifies the security settings that apply to this backend service.
|
SecuritySettingsOrBuilder |
getSecuritySettingsOrBuilder()
This field specifies the security settings that apply to this backend service.
|
String |
getSelfLink()
[Output Only] Server-defined URL for the resource.
|
com.google.protobuf.ByteString |
getSelfLinkBytes()
[Output Only] Server-defined URL for the resource.
|
int |
getSerializedSize() |
String |
getServiceBindings(int index)
URLs of networkservices.ServiceBinding resources.
|
com.google.protobuf.ByteString |
getServiceBindingsBytes(int index)
URLs of networkservices.ServiceBinding resources.
|
int |
getServiceBindingsCount()
URLs of networkservices.ServiceBinding resources.
|
com.google.protobuf.ProtocolStringList |
getServiceBindingsList()
URLs of networkservices.ServiceBinding resources.
|
String |
getSessionAffinity()
Type of session affinity to use.
|
com.google.protobuf.ByteString |
getSessionAffinityBytes()
Type of session affinity to use.
|
Subsetting |
getSubsetting()
optional .google.cloud.compute.v1.Subsetting subsetting = 450283536; |
SubsettingOrBuilder |
getSubsettingOrBuilder()
optional .google.cloud.compute.v1.Subsetting subsetting = 450283536; |
int |
getTimeoutSec()
The backend service timeout has a different meaning depending on the type of load balancer.
|
com.google.protobuf.UnknownFieldSet |
getUnknownFields() |
boolean |
hasAffinityCookieTtlSec()
Lifetime of cookies in seconds.
|
boolean |
hasCdnPolicy()
Cloud CDN configuration for this BackendService.
|
boolean |
hasCircuitBreakers()
optional .google.cloud.compute.v1.CircuitBreakers circuit_breakers = 421340061; |
boolean |
hasCompressionMode()
Compress text responses using Brotli or gzip compression, based on the client's Accept-Encoding header.
|
boolean |
hasConnectionDraining()
optional .google.cloud.compute.v1.ConnectionDraining connection_draining = 461096747;
|
boolean |
hasConnectionTrackingPolicy()
Connection Tracking configuration for this BackendService.
|
boolean |
hasConsistentHash()
Consistent Hash-based load balancing can be used to provide soft session affinity based on HTTP headers, cookies or other properties.
|
boolean |
hasCreationTimestamp()
[Output Only] Creation timestamp in RFC3339 text format.
|
boolean |
hasDescription()
An optional description of this resource.
|
boolean |
hasEdgeSecurityPolicy()
[Output Only] The resource URL for the edge security policy associated with this backend service.
|
boolean |
hasEnableCDN()
If true, enables Cloud CDN for the backend service of an external HTTP(S) load balancer.
|
boolean |
hasFailoverPolicy()
Requires at least one backend instance group to be defined as a backup (failover) backend.
|
boolean |
hasFingerprint()
Fingerprint of this resource.
|
int |
hashCode() |
boolean |
hasIap()
The configurations for Identity-Aware Proxy on this resource.
|
boolean |
hasId()
[Output Only] The unique identifier for the resource.
|
boolean |
hasKind()
[Output Only] Type of resource.
|
boolean |
hasLoadBalancingScheme()
Specifies the load balancer type.
|
boolean |
hasLocalityLbPolicy()
The load balancing algorithm used within the scope of the locality.
|
boolean |
hasLogConfig()
This field denotes the logging options for the load balancer traffic served by this backend service.
|
boolean |
hasMaxStreamDuration()
Specifies the default maximum duration (timeout) for streams to this service.
|
boolean |
hasName()
Name of the resource.
|
boolean |
hasNetwork()
The URL of the network to which this backend service belongs.
|
boolean |
hasOutlierDetection()
Settings controlling the eviction of unhealthy hosts from the load balancing pool for the backend service.
|
boolean |
hasPort()
Deprecated in favor of portName.
|
boolean |
hasPortName()
A named port on a backend instance group representing the port for communication to the backend VMs in that group.
|
boolean |
hasProtocol()
The protocol this BackendService uses to communicate with backends.
|
boolean |
hasRegion()
[Output Only] URL of the region where the regional backend service resides.
|
boolean |
hasSecurityPolicy()
[Output Only] The resource URL for the security policy associated with this backend service.
|
boolean |
hasSecuritySettings()
This field specifies the security settings that apply to this backend service.
|
boolean |
hasSelfLink()
[Output Only] Server-defined URL for the resource.
|
boolean |
hasSessionAffinity()
Type of session affinity to use.
|
boolean |
hasSubsetting()
optional .google.cloud.compute.v1.Subsetting subsetting = 450283536; |
boolean |
hasTimeoutSec()
The backend service timeout has a different meaning depending on the type of load balancer.
|
protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable |
internalGetFieldAccessorTable() |
boolean |
isInitialized() |
static BackendService.Builder |
newBuilder() |
static BackendService.Builder |
newBuilder(BackendService prototype) |
BackendService.Builder |
newBuilderForType() |
protected BackendService.Builder |
newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent) |
protected Object |
newInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused) |
static BackendService |
parseDelimitedFrom(InputStream input) |
static BackendService |
parseDelimitedFrom(InputStream input,
com.google.protobuf.ExtensionRegistryLite extensionRegistry) |
static BackendService |
parseFrom(byte[] data) |
static BackendService |
parseFrom(byte[] data,
com.google.protobuf.ExtensionRegistryLite extensionRegistry) |
static BackendService |
parseFrom(ByteBuffer data) |
static BackendService |
parseFrom(ByteBuffer data,
com.google.protobuf.ExtensionRegistryLite extensionRegistry) |
static BackendService |
parseFrom(com.google.protobuf.ByteString data) |
static BackendService |
parseFrom(com.google.protobuf.ByteString data,
com.google.protobuf.ExtensionRegistryLite extensionRegistry) |
static BackendService |
parseFrom(com.google.protobuf.CodedInputStream input) |
static BackendService |
parseFrom(com.google.protobuf.CodedInputStream input,
com.google.protobuf.ExtensionRegistryLite extensionRegistry) |
static BackendService |
parseFrom(InputStream input) |
static BackendService |
parseFrom(InputStream input,
com.google.protobuf.ExtensionRegistryLite extensionRegistry) |
static com.google.protobuf.Parser<BackendService> |
parser() |
BackendService.Builder |
toBuilder() |
void |
writeTo(com.google.protobuf.CodedOutputStream output) |
canUseUnsafe, computeStringSize, computeStringSizeNoTag, emptyBooleanList, emptyDoubleList, emptyFloatList, emptyIntList, emptyLongList, getAllFields, getDescriptorForType, getField, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, hasField, hasOneof, internalGetMapField, isStringEmpty, makeExtensionsImmutable, mergeFromAndMakeImmutableInternal, mutableCopy, mutableCopy, mutableCopy, mutableCopy, mutableCopy, newBooleanList, newBuilderForType, newDoubleList, newFloatList, newIntList, newLongList, parseDelimitedWithIOException, parseDelimitedWithIOException, parseUnknownField, parseUnknownFieldProto3, parseWithIOException, parseWithIOException, parseWithIOException, parseWithIOException, serializeBooleanMapTo, serializeIntegerMapTo, serializeLongMapTo, serializeStringMapTo, writeReplace, writeString, writeStringNoTagfindInitializationErrors, getInitializationErrorString, hashBoolean, hashEnum, hashEnumList, hashFields, hashLong, toStringaddAll, addAll, checkByteStringIsUtf8, toByteArray, toByteString, writeDelimitedTo, writeToclone, finalize, getClass, notify, notifyAll, wait, wait, waitpublic static final int AFFINITY_COOKIE_TTL_SEC_FIELD_NUMBER
public static final int BACKENDS_FIELD_NUMBER
public static final int CDN_POLICY_FIELD_NUMBER
public static final int CIRCUIT_BREAKERS_FIELD_NUMBER
public static final int COMPRESSION_MODE_FIELD_NUMBER
public static final int CONNECTION_DRAINING_FIELD_NUMBER
public static final int CONNECTION_TRACKING_POLICY_FIELD_NUMBER
public static final int CONSISTENT_HASH_FIELD_NUMBER
public static final int CREATION_TIMESTAMP_FIELD_NUMBER
public static final int CUSTOM_REQUEST_HEADERS_FIELD_NUMBER
public static final int CUSTOM_RESPONSE_HEADERS_FIELD_NUMBER
public static final int DESCRIPTION_FIELD_NUMBER
public static final int EDGE_SECURITY_POLICY_FIELD_NUMBER
public static final int ENABLE_C_D_N_FIELD_NUMBER
public static final int FAILOVER_POLICY_FIELD_NUMBER
public static final int FINGERPRINT_FIELD_NUMBER
public static final int HEALTH_CHECKS_FIELD_NUMBER
public static final int IAP_FIELD_NUMBER
public static final int ID_FIELD_NUMBER
public static final int KIND_FIELD_NUMBER
public static final int LOAD_BALANCING_SCHEME_FIELD_NUMBER
public static final int LOCALITY_LB_POLICIES_FIELD_NUMBER
public static final int LOCALITY_LB_POLICY_FIELD_NUMBER
public static final int LOG_CONFIG_FIELD_NUMBER
public static final int MAX_STREAM_DURATION_FIELD_NUMBER
public static final int NAME_FIELD_NUMBER
public static final int NETWORK_FIELD_NUMBER
public static final int OUTLIER_DETECTION_FIELD_NUMBER
public static final int PORT_FIELD_NUMBER
public static final int PORT_NAME_FIELD_NUMBER
public static final int PROTOCOL_FIELD_NUMBER
public static final int REGION_FIELD_NUMBER
public static final int SECURITY_POLICY_FIELD_NUMBER
public static final int SECURITY_SETTINGS_FIELD_NUMBER
public static final int SELF_LINK_FIELD_NUMBER
public static final int SERVICE_BINDINGS_FIELD_NUMBER
public static final int SESSION_AFFINITY_FIELD_NUMBER
public static final int SUBSETTING_FIELD_NUMBER
public static final int TIMEOUT_SEC_FIELD_NUMBER
protected Object newInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)
newInstance in class com.google.protobuf.GeneratedMessageV3public final com.google.protobuf.UnknownFieldSet getUnknownFields()
getUnknownFields in interface com.google.protobuf.MessageOrBuildergetUnknownFields in class com.google.protobuf.GeneratedMessageV3public static final com.google.protobuf.Descriptors.Descriptor getDescriptor()
protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessageV3public boolean hasAffinityCookieTtlSec()
Lifetime of cookies in seconds. This setting is applicable to external and internal HTTP(S) load balancers and Traffic Director and requires GENERATED_COOKIE or HTTP_COOKIE session affinity. If set to 0, the cookie is non-persistent and lasts only until the end of the browser session (or equivalent). The maximum allowed value is two weeks (1,209,600). Not supported when the backend service is referenced by a URL map that is bound to target gRPC proxy that has validateForProxyless field set to true.
optional int32 affinity_cookie_ttl_sec = 369996954;hasAffinityCookieTtlSec in interface BackendServiceOrBuilderpublic int getAffinityCookieTtlSec()
Lifetime of cookies in seconds. This setting is applicable to external and internal HTTP(S) load balancers and Traffic Director and requires GENERATED_COOKIE or HTTP_COOKIE session affinity. If set to 0, the cookie is non-persistent and lasts only until the end of the browser session (or equivalent). The maximum allowed value is two weeks (1,209,600). Not supported when the backend service is referenced by a URL map that is bound to target gRPC proxy that has validateForProxyless field set to true.
optional int32 affinity_cookie_ttl_sec = 369996954;getAffinityCookieTtlSec in interface BackendServiceOrBuilderpublic List<Backend> getBackendsList()
The list of backends that serve this BackendService.
repeated .google.cloud.compute.v1.Backend backends = 510839903;getBackendsList in interface BackendServiceOrBuilderpublic List<? extends BackendOrBuilder> getBackendsOrBuilderList()
The list of backends that serve this BackendService.
repeated .google.cloud.compute.v1.Backend backends = 510839903;getBackendsOrBuilderList in interface BackendServiceOrBuilderpublic int getBackendsCount()
The list of backends that serve this BackendService.
repeated .google.cloud.compute.v1.Backend backends = 510839903;getBackendsCount in interface BackendServiceOrBuilderpublic Backend getBackends(int index)
The list of backends that serve this BackendService.
repeated .google.cloud.compute.v1.Backend backends = 510839903;getBackends in interface BackendServiceOrBuilderpublic BackendOrBuilder getBackendsOrBuilder(int index)
The list of backends that serve this BackendService.
repeated .google.cloud.compute.v1.Backend backends = 510839903;getBackendsOrBuilder in interface BackendServiceOrBuilderpublic boolean hasCdnPolicy()
Cloud CDN configuration for this BackendService. Only available for specified load balancer types.
optional .google.cloud.compute.v1.BackendServiceCdnPolicy cdn_policy = 213976452;hasCdnPolicy in interface BackendServiceOrBuilderpublic BackendServiceCdnPolicy getCdnPolicy()
Cloud CDN configuration for this BackendService. Only available for specified load balancer types.
optional .google.cloud.compute.v1.BackendServiceCdnPolicy cdn_policy = 213976452;getCdnPolicy in interface BackendServiceOrBuilderpublic BackendServiceCdnPolicyOrBuilder getCdnPolicyOrBuilder()
Cloud CDN configuration for this BackendService. Only available for specified load balancer types.
optional .google.cloud.compute.v1.BackendServiceCdnPolicy cdn_policy = 213976452;getCdnPolicyOrBuilder in interface BackendServiceOrBuilderpublic boolean hasCircuitBreakers()
optional .google.cloud.compute.v1.CircuitBreakers circuit_breakers = 421340061;hasCircuitBreakers in interface BackendServiceOrBuilderpublic CircuitBreakers getCircuitBreakers()
optional .google.cloud.compute.v1.CircuitBreakers circuit_breakers = 421340061;getCircuitBreakers in interface BackendServiceOrBuilderpublic CircuitBreakersOrBuilder getCircuitBreakersOrBuilder()
optional .google.cloud.compute.v1.CircuitBreakers circuit_breakers = 421340061;getCircuitBreakersOrBuilder in interface BackendServiceOrBuilderpublic boolean hasCompressionMode()
Compress text responses using Brotli or gzip compression, based on the client's Accept-Encoding header. Check the CompressionMode enum for the list of possible values.
optional string compression_mode = 95520988;hasCompressionMode in interface BackendServiceOrBuilderpublic String getCompressionMode()
Compress text responses using Brotli or gzip compression, based on the client's Accept-Encoding header. Check the CompressionMode enum for the list of possible values.
optional string compression_mode = 95520988;getCompressionMode in interface BackendServiceOrBuilderpublic com.google.protobuf.ByteString getCompressionModeBytes()
Compress text responses using Brotli or gzip compression, based on the client's Accept-Encoding header. Check the CompressionMode enum for the list of possible values.
optional string compression_mode = 95520988;getCompressionModeBytes in interface BackendServiceOrBuilderpublic boolean hasConnectionDraining()
optional .google.cloud.compute.v1.ConnectionDraining connection_draining = 461096747;
hasConnectionDraining in interface BackendServiceOrBuilderpublic ConnectionDraining getConnectionDraining()
optional .google.cloud.compute.v1.ConnectionDraining connection_draining = 461096747;
getConnectionDraining in interface BackendServiceOrBuilderpublic ConnectionDrainingOrBuilder getConnectionDrainingOrBuilder()
optional .google.cloud.compute.v1.ConnectionDraining connection_draining = 461096747;
getConnectionDrainingOrBuilder in interface BackendServiceOrBuilderpublic boolean hasConnectionTrackingPolicy()
Connection Tracking configuration for this BackendService. Connection tracking policy settings are only available for Network Load Balancing and Internal TCP/UDP Load Balancing.
optional .google.cloud.compute.v1.BackendServiceConnectionTrackingPolicy connection_tracking_policy = 143994969;
hasConnectionTrackingPolicy in interface BackendServiceOrBuilderpublic BackendServiceConnectionTrackingPolicy getConnectionTrackingPolicy()
Connection Tracking configuration for this BackendService. Connection tracking policy settings are only available for Network Load Balancing and Internal TCP/UDP Load Balancing.
optional .google.cloud.compute.v1.BackendServiceConnectionTrackingPolicy connection_tracking_policy = 143994969;
getConnectionTrackingPolicy in interface BackendServiceOrBuilderpublic BackendServiceConnectionTrackingPolicyOrBuilder getConnectionTrackingPolicyOrBuilder()
Connection Tracking configuration for this BackendService. Connection tracking policy settings are only available for Network Load Balancing and Internal TCP/UDP Load Balancing.
optional .google.cloud.compute.v1.BackendServiceConnectionTrackingPolicy connection_tracking_policy = 143994969;
getConnectionTrackingPolicyOrBuilder in interface BackendServiceOrBuilderpublic boolean hasConsistentHash()
Consistent Hash-based load balancing can be used to provide soft session affinity based on HTTP headers, cookies or other properties. This load balancing policy is applicable only for HTTP connections. The affinity to a particular destination host will be lost when one or more hosts are added/removed from the destination service. This field specifies parameters that control consistent hashing. This field is only applicable when localityLbPolicy is set to MAGLEV or RING_HASH. This field is applicable to either: - A regional backend service with the service_protocol set to HTTP, HTTPS, or HTTP2, and load_balancing_scheme set to INTERNAL_MANAGED. - A global backend service with the load_balancing_scheme set to INTERNAL_SELF_MANAGED.
optional .google.cloud.compute.v1.ConsistentHashLoadBalancerSettings consistent_hash = 905883;
hasConsistentHash in interface BackendServiceOrBuilderpublic ConsistentHashLoadBalancerSettings getConsistentHash()
Consistent Hash-based load balancing can be used to provide soft session affinity based on HTTP headers, cookies or other properties. This load balancing policy is applicable only for HTTP connections. The affinity to a particular destination host will be lost when one or more hosts are added/removed from the destination service. This field specifies parameters that control consistent hashing. This field is only applicable when localityLbPolicy is set to MAGLEV or RING_HASH. This field is applicable to either: - A regional backend service with the service_protocol set to HTTP, HTTPS, or HTTP2, and load_balancing_scheme set to INTERNAL_MANAGED. - A global backend service with the load_balancing_scheme set to INTERNAL_SELF_MANAGED.
optional .google.cloud.compute.v1.ConsistentHashLoadBalancerSettings consistent_hash = 905883;
getConsistentHash in interface BackendServiceOrBuilderpublic ConsistentHashLoadBalancerSettingsOrBuilder getConsistentHashOrBuilder()
Consistent Hash-based load balancing can be used to provide soft session affinity based on HTTP headers, cookies or other properties. This load balancing policy is applicable only for HTTP connections. The affinity to a particular destination host will be lost when one or more hosts are added/removed from the destination service. This field specifies parameters that control consistent hashing. This field is only applicable when localityLbPolicy is set to MAGLEV or RING_HASH. This field is applicable to either: - A regional backend service with the service_protocol set to HTTP, HTTPS, or HTTP2, and load_balancing_scheme set to INTERNAL_MANAGED. - A global backend service with the load_balancing_scheme set to INTERNAL_SELF_MANAGED.
optional .google.cloud.compute.v1.ConsistentHashLoadBalancerSettings consistent_hash = 905883;
getConsistentHashOrBuilder in interface BackendServiceOrBuilderpublic boolean hasCreationTimestamp()
[Output Only] Creation timestamp in RFC3339 text format.
optional string creation_timestamp = 30525366;hasCreationTimestamp in interface BackendServiceOrBuilderpublic String getCreationTimestamp()
[Output Only] Creation timestamp in RFC3339 text format.
optional string creation_timestamp = 30525366;getCreationTimestamp in interface BackendServiceOrBuilderpublic com.google.protobuf.ByteString getCreationTimestampBytes()
[Output Only] Creation timestamp in RFC3339 text format.
optional string creation_timestamp = 30525366;getCreationTimestampBytes in interface BackendServiceOrBuilderpublic com.google.protobuf.ProtocolStringList getCustomRequestHeadersList()
Headers that the load balancer adds to proxied requests. See [Creating custom headers](https://cloud.google.com/load-balancing/docs/custom-headers).
repeated string custom_request_headers = 27977992;getCustomRequestHeadersList in interface BackendServiceOrBuilderpublic int getCustomRequestHeadersCount()
Headers that the load balancer adds to proxied requests. See [Creating custom headers](https://cloud.google.com/load-balancing/docs/custom-headers).
repeated string custom_request_headers = 27977992;getCustomRequestHeadersCount in interface BackendServiceOrBuilderpublic String getCustomRequestHeaders(int index)
Headers that the load balancer adds to proxied requests. See [Creating custom headers](https://cloud.google.com/load-balancing/docs/custom-headers).
repeated string custom_request_headers = 27977992;getCustomRequestHeaders in interface BackendServiceOrBuilderindex - The index of the element to return.public com.google.protobuf.ByteString getCustomRequestHeadersBytes(int index)
Headers that the load balancer adds to proxied requests. See [Creating custom headers](https://cloud.google.com/load-balancing/docs/custom-headers).
repeated string custom_request_headers = 27977992;getCustomRequestHeadersBytes in interface BackendServiceOrBuilderindex - The index of the value to return.public com.google.protobuf.ProtocolStringList getCustomResponseHeadersList()
Headers that the load balancer adds to proxied responses. See [Creating custom headers](https://cloud.google.com/load-balancing/docs/custom-headers).
repeated string custom_response_headers = 387539094;getCustomResponseHeadersList in interface BackendServiceOrBuilderpublic int getCustomResponseHeadersCount()
Headers that the load balancer adds to proxied responses. See [Creating custom headers](https://cloud.google.com/load-balancing/docs/custom-headers).
repeated string custom_response_headers = 387539094;getCustomResponseHeadersCount in interface BackendServiceOrBuilderpublic String getCustomResponseHeaders(int index)
Headers that the load balancer adds to proxied responses. See [Creating custom headers](https://cloud.google.com/load-balancing/docs/custom-headers).
repeated string custom_response_headers = 387539094;getCustomResponseHeaders in interface BackendServiceOrBuilderindex - The index of the element to return.public com.google.protobuf.ByteString getCustomResponseHeadersBytes(int index)
Headers that the load balancer adds to proxied responses. See [Creating custom headers](https://cloud.google.com/load-balancing/docs/custom-headers).
repeated string custom_response_headers = 387539094;getCustomResponseHeadersBytes in interface BackendServiceOrBuilderindex - The index of the value to return.public boolean hasDescription()
An optional description of this resource. Provide this property when you create the resource.
optional string description = 422937596;hasDescription in interface BackendServiceOrBuilderpublic String getDescription()
An optional description of this resource. Provide this property when you create the resource.
optional string description = 422937596;getDescription in interface BackendServiceOrBuilderpublic com.google.protobuf.ByteString getDescriptionBytes()
An optional description of this resource. Provide this property when you create the resource.
optional string description = 422937596;getDescriptionBytes in interface BackendServiceOrBuilderpublic boolean hasEdgeSecurityPolicy()
[Output Only] The resource URL for the edge security policy associated with this backend service.
optional string edge_security_policy = 41036943;hasEdgeSecurityPolicy in interface BackendServiceOrBuilderpublic String getEdgeSecurityPolicy()
[Output Only] The resource URL for the edge security policy associated with this backend service.
optional string edge_security_policy = 41036943;getEdgeSecurityPolicy in interface BackendServiceOrBuilderpublic com.google.protobuf.ByteString getEdgeSecurityPolicyBytes()
[Output Only] The resource URL for the edge security policy associated with this backend service.
optional string edge_security_policy = 41036943;getEdgeSecurityPolicyBytes in interface BackendServiceOrBuilderpublic boolean hasEnableCDN()
If true, enables Cloud CDN for the backend service of an external HTTP(S) load balancer.
optional bool enable_c_d_n = 250733499;hasEnableCDN in interface BackendServiceOrBuilderpublic boolean getEnableCDN()
If true, enables Cloud CDN for the backend service of an external HTTP(S) load balancer.
optional bool enable_c_d_n = 250733499;getEnableCDN in interface BackendServiceOrBuilderpublic boolean hasFailoverPolicy()
Requires at least one backend instance group to be defined as a backup (failover) backend. For load balancers that have configurable failover: [Internal TCP/UDP Load Balancing](https://cloud.google.com/load-balancing/docs/internal/failover-overview) and [external TCP/UDP Load Balancing](https://cloud.google.com/load-balancing/docs/network/networklb-failover-overview).
optional .google.cloud.compute.v1.BackendServiceFailoverPolicy failover_policy = 105658655;
hasFailoverPolicy in interface BackendServiceOrBuilderpublic BackendServiceFailoverPolicy getFailoverPolicy()
Requires at least one backend instance group to be defined as a backup (failover) backend. For load balancers that have configurable failover: [Internal TCP/UDP Load Balancing](https://cloud.google.com/load-balancing/docs/internal/failover-overview) and [external TCP/UDP Load Balancing](https://cloud.google.com/load-balancing/docs/network/networklb-failover-overview).
optional .google.cloud.compute.v1.BackendServiceFailoverPolicy failover_policy = 105658655;
getFailoverPolicy in interface BackendServiceOrBuilderpublic BackendServiceFailoverPolicyOrBuilder getFailoverPolicyOrBuilder()
Requires at least one backend instance group to be defined as a backup (failover) backend. For load balancers that have configurable failover: [Internal TCP/UDP Load Balancing](https://cloud.google.com/load-balancing/docs/internal/failover-overview) and [external TCP/UDP Load Balancing](https://cloud.google.com/load-balancing/docs/network/networklb-failover-overview).
optional .google.cloud.compute.v1.BackendServiceFailoverPolicy failover_policy = 105658655;
getFailoverPolicyOrBuilder in interface BackendServiceOrBuilderpublic boolean hasFingerprint()
Fingerprint of this resource. A hash of the contents stored in this object. This field is used in optimistic locking. This field will be ignored when inserting a BackendService. An up-to-date fingerprint must be provided in order to update the BackendService, otherwise the request will fail with error 412 conditionNotMet. To see the latest fingerprint, make a get() request to retrieve a BackendService.
optional string fingerprint = 234678500;hasFingerprint in interface BackendServiceOrBuilderpublic String getFingerprint()
Fingerprint of this resource. A hash of the contents stored in this object. This field is used in optimistic locking. This field will be ignored when inserting a BackendService. An up-to-date fingerprint must be provided in order to update the BackendService, otherwise the request will fail with error 412 conditionNotMet. To see the latest fingerprint, make a get() request to retrieve a BackendService.
optional string fingerprint = 234678500;getFingerprint in interface BackendServiceOrBuilderpublic com.google.protobuf.ByteString getFingerprintBytes()
Fingerprint of this resource. A hash of the contents stored in this object. This field is used in optimistic locking. This field will be ignored when inserting a BackendService. An up-to-date fingerprint must be provided in order to update the BackendService, otherwise the request will fail with error 412 conditionNotMet. To see the latest fingerprint, make a get() request to retrieve a BackendService.
optional string fingerprint = 234678500;getFingerprintBytes in interface BackendServiceOrBuilderpublic com.google.protobuf.ProtocolStringList getHealthChecksList()
The list of URLs to the healthChecks, httpHealthChecks (legacy), or httpsHealthChecks (legacy) resource for health checking this backend service. Not all backend services support legacy health checks. See Load balancer guide. Currently, at most one health check can be specified for each backend service. Backend services with instance group or zonal NEG backends must have a health check. Backend services with internet or serverless NEG backends must not have a health check.
repeated string health_checks = 448370606;getHealthChecksList in interface BackendServiceOrBuilderpublic int getHealthChecksCount()
The list of URLs to the healthChecks, httpHealthChecks (legacy), or httpsHealthChecks (legacy) resource for health checking this backend service. Not all backend services support legacy health checks. See Load balancer guide. Currently, at most one health check can be specified for each backend service. Backend services with instance group or zonal NEG backends must have a health check. Backend services with internet or serverless NEG backends must not have a health check.
repeated string health_checks = 448370606;getHealthChecksCount in interface BackendServiceOrBuilderpublic String getHealthChecks(int index)
The list of URLs to the healthChecks, httpHealthChecks (legacy), or httpsHealthChecks (legacy) resource for health checking this backend service. Not all backend services support legacy health checks. See Load balancer guide. Currently, at most one health check can be specified for each backend service. Backend services with instance group or zonal NEG backends must have a health check. Backend services with internet or serverless NEG backends must not have a health check.
repeated string health_checks = 448370606;getHealthChecks in interface BackendServiceOrBuilderindex - The index of the element to return.public com.google.protobuf.ByteString getHealthChecksBytes(int index)
The list of URLs to the healthChecks, httpHealthChecks (legacy), or httpsHealthChecks (legacy) resource for health checking this backend service. Not all backend services support legacy health checks. See Load balancer guide. Currently, at most one health check can be specified for each backend service. Backend services with instance group or zonal NEG backends must have a health check. Backend services with internet or serverless NEG backends must not have a health check.
repeated string health_checks = 448370606;getHealthChecksBytes in interface BackendServiceOrBuilderindex - The index of the value to return.public boolean hasIap()
The configurations for Identity-Aware Proxy on this resource. Not available for Internal TCP/UDP Load Balancing and Network Load Balancing.
optional .google.cloud.compute.v1.BackendServiceIAP iap = 104024;hasIap in interface BackendServiceOrBuilderpublic BackendServiceIAP getIap()
The configurations for Identity-Aware Proxy on this resource. Not available for Internal TCP/UDP Load Balancing and Network Load Balancing.
optional .google.cloud.compute.v1.BackendServiceIAP iap = 104024;getIap in interface BackendServiceOrBuilderpublic BackendServiceIAPOrBuilder getIapOrBuilder()
The configurations for Identity-Aware Proxy on this resource. Not available for Internal TCP/UDP Load Balancing and Network Load Balancing.
optional .google.cloud.compute.v1.BackendServiceIAP iap = 104024;getIapOrBuilder in interface BackendServiceOrBuilderpublic boolean hasId()
[Output Only] The unique identifier for the resource. This identifier is defined by the server.
optional uint64 id = 3355;hasId in interface BackendServiceOrBuilderpublic long getId()
[Output Only] The unique identifier for the resource. This identifier is defined by the server.
optional uint64 id = 3355;getId in interface BackendServiceOrBuilderpublic boolean hasKind()
[Output Only] Type of resource. Always compute#backendService for backend services.
optional string kind = 3292052;hasKind in interface BackendServiceOrBuilderpublic String getKind()
[Output Only] Type of resource. Always compute#backendService for backend services.
optional string kind = 3292052;getKind in interface BackendServiceOrBuilderpublic com.google.protobuf.ByteString getKindBytes()
[Output Only] Type of resource. Always compute#backendService for backend services.
optional string kind = 3292052;getKindBytes in interface BackendServiceOrBuilderpublic boolean hasLoadBalancingScheme()
Specifies the load balancer type. A backend service created for one type of load balancer cannot be used with another. For more information, refer to Choosing a load balancer. Check the LoadBalancingScheme enum for the list of possible values.
optional string load_balancing_scheme = 363890244;hasLoadBalancingScheme in interface BackendServiceOrBuilderpublic String getLoadBalancingScheme()
Specifies the load balancer type. A backend service created for one type of load balancer cannot be used with another. For more information, refer to Choosing a load balancer. Check the LoadBalancingScheme enum for the list of possible values.
optional string load_balancing_scheme = 363890244;getLoadBalancingScheme in interface BackendServiceOrBuilderpublic com.google.protobuf.ByteString getLoadBalancingSchemeBytes()
Specifies the load balancer type. A backend service created for one type of load balancer cannot be used with another. For more information, refer to Choosing a load balancer. Check the LoadBalancingScheme enum for the list of possible values.
optional string load_balancing_scheme = 363890244;getLoadBalancingSchemeBytes in interface BackendServiceOrBuilderpublic List<BackendServiceLocalityLoadBalancingPolicyConfig> getLocalityLbPoliciesList()
A list of locality load balancing policies to be used in order of preference. Either the policy or the customPolicy field should be set. Overrides any value set in the localityLbPolicy field. localityLbPolicies is only supported when the BackendService is referenced by a URL Map that is referenced by a target gRPC proxy that has the validateForProxyless field set to true.
repeated .google.cloud.compute.v1.BackendServiceLocalityLoadBalancingPolicyConfig locality_lb_policies = 140982557;
getLocalityLbPoliciesList in interface BackendServiceOrBuilderpublic List<? extends BackendServiceLocalityLoadBalancingPolicyConfigOrBuilder> getLocalityLbPoliciesOrBuilderList()
A list of locality load balancing policies to be used in order of preference. Either the policy or the customPolicy field should be set. Overrides any value set in the localityLbPolicy field. localityLbPolicies is only supported when the BackendService is referenced by a URL Map that is referenced by a target gRPC proxy that has the validateForProxyless field set to true.
repeated .google.cloud.compute.v1.BackendServiceLocalityLoadBalancingPolicyConfig locality_lb_policies = 140982557;
getLocalityLbPoliciesOrBuilderList in interface BackendServiceOrBuilderpublic int getLocalityLbPoliciesCount()
A list of locality load balancing policies to be used in order of preference. Either the policy or the customPolicy field should be set. Overrides any value set in the localityLbPolicy field. localityLbPolicies is only supported when the BackendService is referenced by a URL Map that is referenced by a target gRPC proxy that has the validateForProxyless field set to true.
repeated .google.cloud.compute.v1.BackendServiceLocalityLoadBalancingPolicyConfig locality_lb_policies = 140982557;
getLocalityLbPoliciesCount in interface BackendServiceOrBuilderpublic BackendServiceLocalityLoadBalancingPolicyConfig getLocalityLbPolicies(int index)
A list of locality load balancing policies to be used in order of preference. Either the policy or the customPolicy field should be set. Overrides any value set in the localityLbPolicy field. localityLbPolicies is only supported when the BackendService is referenced by a URL Map that is referenced by a target gRPC proxy that has the validateForProxyless field set to true.
repeated .google.cloud.compute.v1.BackendServiceLocalityLoadBalancingPolicyConfig locality_lb_policies = 140982557;
getLocalityLbPolicies in interface BackendServiceOrBuilderpublic BackendServiceLocalityLoadBalancingPolicyConfigOrBuilder getLocalityLbPoliciesOrBuilder(int index)
A list of locality load balancing policies to be used in order of preference. Either the policy or the customPolicy field should be set. Overrides any value set in the localityLbPolicy field. localityLbPolicies is only supported when the BackendService is referenced by a URL Map that is referenced by a target gRPC proxy that has the validateForProxyless field set to true.
repeated .google.cloud.compute.v1.BackendServiceLocalityLoadBalancingPolicyConfig locality_lb_policies = 140982557;
getLocalityLbPoliciesOrBuilder in interface BackendServiceOrBuilderpublic boolean hasLocalityLbPolicy()
The load balancing algorithm used within the scope of the locality. The possible values are: - ROUND_ROBIN: This is a simple policy in which each healthy backend is selected in round robin order. This is the default. - LEAST_REQUEST: An O(1) algorithm which selects two random healthy hosts and picks the host which has fewer active requests. - RING_HASH: The ring/modulo hash load balancer implements consistent hashing to backends. The algorithm has the property that the addition/removal of a host from a set of N hosts only affects 1/N of the requests. - RANDOM: The load balancer selects a random healthy host. - ORIGINAL_DESTINATION: Backend host is selected based on the client connection metadata, i.e., connections are opened to the same address as the destination address of the incoming connection before the connection was redirected to the load balancer. - MAGLEV: used as a drop in replacement for the ring hash load balancer. Maglev is not as stable as ring hash but has faster table lookup build times and host selection times. For more information about Maglev, see https://ai.google/research/pubs/pub44824 This field is applicable to either: - A regional backend service with the service_protocol set to HTTP, HTTPS, or HTTP2, and load_balancing_scheme set to INTERNAL_MANAGED. - A global backend service with the load_balancing_scheme set to INTERNAL_SELF_MANAGED. If sessionAffinity is not NONE, and this field is not set to MAGLEV or RING_HASH, session affinity settings will not take effect. Only ROUND_ROBIN and RING_HASH are supported when the backend service is referenced by a URL map that is bound to target gRPC proxy that has validateForProxyless field set to true. Check the LocalityLbPolicy enum for the list of possible values.
optional string locality_lb_policy = 131431487;hasLocalityLbPolicy in interface BackendServiceOrBuilderpublic String getLocalityLbPolicy()
The load balancing algorithm used within the scope of the locality. The possible values are: - ROUND_ROBIN: This is a simple policy in which each healthy backend is selected in round robin order. This is the default. - LEAST_REQUEST: An O(1) algorithm which selects two random healthy hosts and picks the host which has fewer active requests. - RING_HASH: The ring/modulo hash load balancer implements consistent hashing to backends. The algorithm has the property that the addition/removal of a host from a set of N hosts only affects 1/N of the requests. - RANDOM: The load balancer selects a random healthy host. - ORIGINAL_DESTINATION: Backend host is selected based on the client connection metadata, i.e., connections are opened to the same address as the destination address of the incoming connection before the connection was redirected to the load balancer. - MAGLEV: used as a drop in replacement for the ring hash load balancer. Maglev is not as stable as ring hash but has faster table lookup build times and host selection times. For more information about Maglev, see https://ai.google/research/pubs/pub44824 This field is applicable to either: - A regional backend service with the service_protocol set to HTTP, HTTPS, or HTTP2, and load_balancing_scheme set to INTERNAL_MANAGED. - A global backend service with the load_balancing_scheme set to INTERNAL_SELF_MANAGED. If sessionAffinity is not NONE, and this field is not set to MAGLEV or RING_HASH, session affinity settings will not take effect. Only ROUND_ROBIN and RING_HASH are supported when the backend service is referenced by a URL map that is bound to target gRPC proxy that has validateForProxyless field set to true. Check the LocalityLbPolicy enum for the list of possible values.
optional string locality_lb_policy = 131431487;getLocalityLbPolicy in interface BackendServiceOrBuilderpublic com.google.protobuf.ByteString getLocalityLbPolicyBytes()
The load balancing algorithm used within the scope of the locality. The possible values are: - ROUND_ROBIN: This is a simple policy in which each healthy backend is selected in round robin order. This is the default. - LEAST_REQUEST: An O(1) algorithm which selects two random healthy hosts and picks the host which has fewer active requests. - RING_HASH: The ring/modulo hash load balancer implements consistent hashing to backends. The algorithm has the property that the addition/removal of a host from a set of N hosts only affects 1/N of the requests. - RANDOM: The load balancer selects a random healthy host. - ORIGINAL_DESTINATION: Backend host is selected based on the client connection metadata, i.e., connections are opened to the same address as the destination address of the incoming connection before the connection was redirected to the load balancer. - MAGLEV: used as a drop in replacement for the ring hash load balancer. Maglev is not as stable as ring hash but has faster table lookup build times and host selection times. For more information about Maglev, see https://ai.google/research/pubs/pub44824 This field is applicable to either: - A regional backend service with the service_protocol set to HTTP, HTTPS, or HTTP2, and load_balancing_scheme set to INTERNAL_MANAGED. - A global backend service with the load_balancing_scheme set to INTERNAL_SELF_MANAGED. If sessionAffinity is not NONE, and this field is not set to MAGLEV or RING_HASH, session affinity settings will not take effect. Only ROUND_ROBIN and RING_HASH are supported when the backend service is referenced by a URL map that is bound to target gRPC proxy that has validateForProxyless field set to true. Check the LocalityLbPolicy enum for the list of possible values.
optional string locality_lb_policy = 131431487;getLocalityLbPolicyBytes in interface BackendServiceOrBuilderpublic boolean hasLogConfig()
This field denotes the logging options for the load balancer traffic served by this backend service. If logging is enabled, logs will be exported to Stackdriver.
optional .google.cloud.compute.v1.BackendServiceLogConfig log_config = 351299741;hasLogConfig in interface BackendServiceOrBuilderpublic BackendServiceLogConfig getLogConfig()
This field denotes the logging options for the load balancer traffic served by this backend service. If logging is enabled, logs will be exported to Stackdriver.
optional .google.cloud.compute.v1.BackendServiceLogConfig log_config = 351299741;getLogConfig in interface BackendServiceOrBuilderpublic BackendServiceLogConfigOrBuilder getLogConfigOrBuilder()
This field denotes the logging options for the load balancer traffic served by this backend service. If logging is enabled, logs will be exported to Stackdriver.
optional .google.cloud.compute.v1.BackendServiceLogConfig log_config = 351299741;getLogConfigOrBuilder in interface BackendServiceOrBuilderpublic boolean hasMaxStreamDuration()
Specifies the default maximum duration (timeout) for streams to this service. Duration is computed from the beginning of the stream until the response has been completely processed, including all retries. A stream that does not complete in this duration is closed. If not specified, there will be no timeout limit, i.e. the maximum duration is infinite. This value can be overridden in the PathMatcher configuration of the UrlMap that references this backend service. This field is only allowed when the loadBalancingScheme of the backend service is INTERNAL_SELF_MANAGED.
optional .google.cloud.compute.v1.Duration max_stream_duration = 61428376;hasMaxStreamDuration in interface BackendServiceOrBuilderpublic Duration getMaxStreamDuration()
Specifies the default maximum duration (timeout) for streams to this service. Duration is computed from the beginning of the stream until the response has been completely processed, including all retries. A stream that does not complete in this duration is closed. If not specified, there will be no timeout limit, i.e. the maximum duration is infinite. This value can be overridden in the PathMatcher configuration of the UrlMap that references this backend service. This field is only allowed when the loadBalancingScheme of the backend service is INTERNAL_SELF_MANAGED.
optional .google.cloud.compute.v1.Duration max_stream_duration = 61428376;getMaxStreamDuration in interface BackendServiceOrBuilderpublic DurationOrBuilder getMaxStreamDurationOrBuilder()
Specifies the default maximum duration (timeout) for streams to this service. Duration is computed from the beginning of the stream until the response has been completely processed, including all retries. A stream that does not complete in this duration is closed. If not specified, there will be no timeout limit, i.e. the maximum duration is infinite. This value can be overridden in the PathMatcher configuration of the UrlMap that references this backend service. This field is only allowed when the loadBalancingScheme of the backend service is INTERNAL_SELF_MANAGED.
optional .google.cloud.compute.v1.Duration max_stream_duration = 61428376;getMaxStreamDurationOrBuilder in interface BackendServiceOrBuilderpublic boolean hasName()
Name of the resource. Provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.
optional string name = 3373707;hasName in interface BackendServiceOrBuilderpublic String getName()
Name of the resource. Provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.
optional string name = 3373707;getName in interface BackendServiceOrBuilderpublic com.google.protobuf.ByteString getNameBytes()
Name of the resource. Provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.
optional string name = 3373707;getNameBytes in interface BackendServiceOrBuilderpublic boolean hasNetwork()
The URL of the network to which this backend service belongs. This field can only be specified when the load balancing scheme is set to INTERNAL.
optional string network = 232872494;hasNetwork in interface BackendServiceOrBuilderpublic String getNetwork()
The URL of the network to which this backend service belongs. This field can only be specified when the load balancing scheme is set to INTERNAL.
optional string network = 232872494;getNetwork in interface BackendServiceOrBuilderpublic com.google.protobuf.ByteString getNetworkBytes()
The URL of the network to which this backend service belongs. This field can only be specified when the load balancing scheme is set to INTERNAL.
optional string network = 232872494;getNetworkBytes in interface BackendServiceOrBuilderpublic boolean hasOutlierDetection()
Settings controlling the eviction of unhealthy hosts from the load balancing pool for the backend service. If not set, this feature is considered disabled. This field is applicable to either: - A regional backend service with the service_protocol set to HTTP, HTTPS, HTTP2, or GRPC, and load_balancing_scheme set to INTERNAL_MANAGED. - A global backend service with the load_balancing_scheme set to INTERNAL_SELF_MANAGED.
optional .google.cloud.compute.v1.OutlierDetection outlier_detection = 354625086;hasOutlierDetection in interface BackendServiceOrBuilderpublic OutlierDetection getOutlierDetection()
Settings controlling the eviction of unhealthy hosts from the load balancing pool for the backend service. If not set, this feature is considered disabled. This field is applicable to either: - A regional backend service with the service_protocol set to HTTP, HTTPS, HTTP2, or GRPC, and load_balancing_scheme set to INTERNAL_MANAGED. - A global backend service with the load_balancing_scheme set to INTERNAL_SELF_MANAGED.
optional .google.cloud.compute.v1.OutlierDetection outlier_detection = 354625086;getOutlierDetection in interface BackendServiceOrBuilderpublic OutlierDetectionOrBuilder getOutlierDetectionOrBuilder()
Settings controlling the eviction of unhealthy hosts from the load balancing pool for the backend service. If not set, this feature is considered disabled. This field is applicable to either: - A regional backend service with the service_protocol set to HTTP, HTTPS, HTTP2, or GRPC, and load_balancing_scheme set to INTERNAL_MANAGED. - A global backend service with the load_balancing_scheme set to INTERNAL_SELF_MANAGED.
optional .google.cloud.compute.v1.OutlierDetection outlier_detection = 354625086;getOutlierDetectionOrBuilder in interface BackendServiceOrBuilderpublic boolean hasPort()
Deprecated in favor of portName. The TCP port to connect on the backend. The default value is 80. For Internal TCP/UDP Load Balancing and Network Load Balancing, omit port.
optional int32 port = 3446913;hasPort in interface BackendServiceOrBuilderpublic int getPort()
Deprecated in favor of portName. The TCP port to connect on the backend. The default value is 80. For Internal TCP/UDP Load Balancing and Network Load Balancing, omit port.
optional int32 port = 3446913;getPort in interface BackendServiceOrBuilderpublic boolean hasPortName()
A named port on a backend instance group representing the port for communication to the backend VMs in that group. The named port must be [defined on each backend instance group](https://cloud.google.com/load-balancing/docs/backend-service#named_ports). This parameter has no meaning if the backends are NEGs. For Internal TCP/UDP Load Balancing and Network Load Balancing, omit port_name.
optional string port_name = 41534345;hasPortName in interface BackendServiceOrBuilderpublic String getPortName()
A named port on a backend instance group representing the port for communication to the backend VMs in that group. The named port must be [defined on each backend instance group](https://cloud.google.com/load-balancing/docs/backend-service#named_ports). This parameter has no meaning if the backends are NEGs. For Internal TCP/UDP Load Balancing and Network Load Balancing, omit port_name.
optional string port_name = 41534345;getPortName in interface BackendServiceOrBuilderpublic com.google.protobuf.ByteString getPortNameBytes()
A named port on a backend instance group representing the port for communication to the backend VMs in that group. The named port must be [defined on each backend instance group](https://cloud.google.com/load-balancing/docs/backend-service#named_ports). This parameter has no meaning if the backends are NEGs. For Internal TCP/UDP Load Balancing and Network Load Balancing, omit port_name.
optional string port_name = 41534345;getPortNameBytes in interface BackendServiceOrBuilderpublic boolean hasProtocol()
The protocol this BackendService uses to communicate with backends. Possible values are HTTP, HTTPS, HTTP2, TCP, SSL, UDP or GRPC. depending on the chosen load balancer or Traffic Director configuration. Refer to the documentation for the load balancers or for Traffic Director for more information. Must be set to GRPC when the backend service is referenced by a URL map that is bound to target gRPC proxy. Check the Protocol enum for the list of possible values.
optional string protocol = 84577944;hasProtocol in interface BackendServiceOrBuilderpublic String getProtocol()
The protocol this BackendService uses to communicate with backends. Possible values are HTTP, HTTPS, HTTP2, TCP, SSL, UDP or GRPC. depending on the chosen load balancer or Traffic Director configuration. Refer to the documentation for the load balancers or for Traffic Director for more information. Must be set to GRPC when the backend service is referenced by a URL map that is bound to target gRPC proxy. Check the Protocol enum for the list of possible values.
optional string protocol = 84577944;getProtocol in interface BackendServiceOrBuilderpublic com.google.protobuf.ByteString getProtocolBytes()
The protocol this BackendService uses to communicate with backends. Possible values are HTTP, HTTPS, HTTP2, TCP, SSL, UDP or GRPC. depending on the chosen load balancer or Traffic Director configuration. Refer to the documentation for the load balancers or for Traffic Director for more information. Must be set to GRPC when the backend service is referenced by a URL map that is bound to target gRPC proxy. Check the Protocol enum for the list of possible values.
optional string protocol = 84577944;getProtocolBytes in interface BackendServiceOrBuilderpublic boolean hasRegion()
[Output Only] URL of the region where the regional backend service resides. This field is not applicable to global backend services. You must specify this field as part of the HTTP request URL. It is not settable as a field in the request body.
optional string region = 138946292;hasRegion in interface BackendServiceOrBuilderpublic String getRegion()
[Output Only] URL of the region where the regional backend service resides. This field is not applicable to global backend services. You must specify this field as part of the HTTP request URL. It is not settable as a field in the request body.
optional string region = 138946292;getRegion in interface BackendServiceOrBuilderpublic com.google.protobuf.ByteString getRegionBytes()
[Output Only] URL of the region where the regional backend service resides. This field is not applicable to global backend services. You must specify this field as part of the HTTP request URL. It is not settable as a field in the request body.
optional string region = 138946292;getRegionBytes in interface BackendServiceOrBuilderpublic boolean hasSecurityPolicy()
[Output Only] The resource URL for the security policy associated with this backend service.
optional string security_policy = 171082513;hasSecurityPolicy in interface BackendServiceOrBuilderpublic String getSecurityPolicy()
[Output Only] The resource URL for the security policy associated with this backend service.
optional string security_policy = 171082513;getSecurityPolicy in interface BackendServiceOrBuilderpublic com.google.protobuf.ByteString getSecurityPolicyBytes()
[Output Only] The resource URL for the security policy associated with this backend service.
optional string security_policy = 171082513;getSecurityPolicyBytes in interface BackendServiceOrBuilderpublic boolean hasSecuritySettings()
This field specifies the security settings that apply to this backend service. This field is applicable to a global backend service with the load_balancing_scheme set to INTERNAL_SELF_MANAGED.
optional .google.cloud.compute.v1.SecuritySettings security_settings = 478649922;hasSecuritySettings in interface BackendServiceOrBuilderpublic SecuritySettings getSecuritySettings()
This field specifies the security settings that apply to this backend service. This field is applicable to a global backend service with the load_balancing_scheme set to INTERNAL_SELF_MANAGED.
optional .google.cloud.compute.v1.SecuritySettings security_settings = 478649922;getSecuritySettings in interface BackendServiceOrBuilderpublic SecuritySettingsOrBuilder getSecuritySettingsOrBuilder()
This field specifies the security settings that apply to this backend service. This field is applicable to a global backend service with the load_balancing_scheme set to INTERNAL_SELF_MANAGED.
optional .google.cloud.compute.v1.SecuritySettings security_settings = 478649922;getSecuritySettingsOrBuilder in interface BackendServiceOrBuilderpublic boolean hasSelfLink()
[Output Only] Server-defined URL for the resource.
optional string self_link = 456214797;hasSelfLink in interface BackendServiceOrBuilderpublic String getSelfLink()
[Output Only] Server-defined URL for the resource.
optional string self_link = 456214797;getSelfLink in interface BackendServiceOrBuilderpublic com.google.protobuf.ByteString getSelfLinkBytes()
[Output Only] Server-defined URL for the resource.
optional string self_link = 456214797;getSelfLinkBytes in interface BackendServiceOrBuilderpublic com.google.protobuf.ProtocolStringList getServiceBindingsList()
URLs of networkservices.ServiceBinding resources. Can only be set if load balancing scheme is INTERNAL_SELF_MANAGED. If set, lists of backends and health checks must be both empty.
repeated string service_bindings = 133581016;getServiceBindingsList in interface BackendServiceOrBuilderpublic int getServiceBindingsCount()
URLs of networkservices.ServiceBinding resources. Can only be set if load balancing scheme is INTERNAL_SELF_MANAGED. If set, lists of backends and health checks must be both empty.
repeated string service_bindings = 133581016;getServiceBindingsCount in interface BackendServiceOrBuilderpublic String getServiceBindings(int index)
URLs of networkservices.ServiceBinding resources. Can only be set if load balancing scheme is INTERNAL_SELF_MANAGED. If set, lists of backends and health checks must be both empty.
repeated string service_bindings = 133581016;getServiceBindings in interface BackendServiceOrBuilderindex - The index of the element to return.public com.google.protobuf.ByteString getServiceBindingsBytes(int index)
URLs of networkservices.ServiceBinding resources. Can only be set if load balancing scheme is INTERNAL_SELF_MANAGED. If set, lists of backends and health checks must be both empty.
repeated string service_bindings = 133581016;getServiceBindingsBytes in interface BackendServiceOrBuilderindex - The index of the value to return.public boolean hasSessionAffinity()
Type of session affinity to use. The default is NONE. Only NONE and HEADER_FIELD are supported when the backend service is referenced by a URL map that is bound to target gRPC proxy that has validateForProxyless field set to true. For more details, see: [Session Affinity](https://cloud.google.com/load-balancing/docs/backend-service#session_affinity). Check the SessionAffinity enum for the list of possible values.
optional string session_affinity = 463888561;hasSessionAffinity in interface BackendServiceOrBuilderpublic String getSessionAffinity()
Type of session affinity to use. The default is NONE. Only NONE and HEADER_FIELD are supported when the backend service is referenced by a URL map that is bound to target gRPC proxy that has validateForProxyless field set to true. For more details, see: [Session Affinity](https://cloud.google.com/load-balancing/docs/backend-service#session_affinity). Check the SessionAffinity enum for the list of possible values.
optional string session_affinity = 463888561;getSessionAffinity in interface BackendServiceOrBuilderpublic com.google.protobuf.ByteString getSessionAffinityBytes()
Type of session affinity to use. The default is NONE. Only NONE and HEADER_FIELD are supported when the backend service is referenced by a URL map that is bound to target gRPC proxy that has validateForProxyless field set to true. For more details, see: [Session Affinity](https://cloud.google.com/load-balancing/docs/backend-service#session_affinity). Check the SessionAffinity enum for the list of possible values.
optional string session_affinity = 463888561;getSessionAffinityBytes in interface BackendServiceOrBuilderpublic boolean hasSubsetting()
optional .google.cloud.compute.v1.Subsetting subsetting = 450283536;hasSubsetting in interface BackendServiceOrBuilderpublic Subsetting getSubsetting()
optional .google.cloud.compute.v1.Subsetting subsetting = 450283536;getSubsetting in interface BackendServiceOrBuilderpublic SubsettingOrBuilder getSubsettingOrBuilder()
optional .google.cloud.compute.v1.Subsetting subsetting = 450283536;getSubsettingOrBuilder in interface BackendServiceOrBuilderpublic boolean hasTimeoutSec()
The backend service timeout has a different meaning depending on the type of load balancer. For more information see, Backend service settings. The default is 30 seconds. The full range of timeout values allowed goes from 1 through 2,147,483,647 seconds. This value can be overridden in the PathMatcher configuration of the UrlMap that references this backend service. Not supported when the backend service is referenced by a URL map that is bound to target gRPC proxy that has validateForProxyless field set to true. Instead, use maxStreamDuration.
optional int32 timeout_sec = 79994995;hasTimeoutSec in interface BackendServiceOrBuilderpublic int getTimeoutSec()
The backend service timeout has a different meaning depending on the type of load balancer. For more information see, Backend service settings. The default is 30 seconds. The full range of timeout values allowed goes from 1 through 2,147,483,647 seconds. This value can be overridden in the PathMatcher configuration of the UrlMap that references this backend service. Not supported when the backend service is referenced by a URL map that is bound to target gRPC proxy that has validateForProxyless field set to true. Instead, use maxStreamDuration.
optional int32 timeout_sec = 79994995;getTimeoutSec in interface BackendServiceOrBuilderpublic final boolean isInitialized()
isInitialized in interface com.google.protobuf.MessageLiteOrBuilderisInitialized in class com.google.protobuf.GeneratedMessageV3public void writeTo(com.google.protobuf.CodedOutputStream output)
throws IOException
writeTo in interface com.google.protobuf.MessageLitewriteTo in class com.google.protobuf.GeneratedMessageV3IOExceptionpublic int getSerializedSize()
getSerializedSize in interface com.google.protobuf.MessageLitegetSerializedSize in class com.google.protobuf.GeneratedMessageV3public boolean equals(Object obj)
equals in interface com.google.protobuf.Messageequals in class com.google.protobuf.AbstractMessagepublic int hashCode()
hashCode in interface com.google.protobuf.MessagehashCode in class com.google.protobuf.AbstractMessagepublic static BackendService parseFrom(ByteBuffer data) throws com.google.protobuf.InvalidProtocolBufferException
com.google.protobuf.InvalidProtocolBufferExceptionpublic static BackendService parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
com.google.protobuf.InvalidProtocolBufferExceptionpublic static BackendService parseFrom(com.google.protobuf.ByteString data) throws com.google.protobuf.InvalidProtocolBufferException
com.google.protobuf.InvalidProtocolBufferExceptionpublic static BackendService parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
com.google.protobuf.InvalidProtocolBufferExceptionpublic static BackendService parseFrom(byte[] data) throws com.google.protobuf.InvalidProtocolBufferException
com.google.protobuf.InvalidProtocolBufferExceptionpublic static BackendService parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
com.google.protobuf.InvalidProtocolBufferExceptionpublic static BackendService parseFrom(InputStream input) throws IOException
IOExceptionpublic static BackendService parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
IOExceptionpublic static BackendService parseDelimitedFrom(InputStream input) throws IOException
IOExceptionpublic static BackendService parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
IOExceptionpublic static BackendService parseFrom(com.google.protobuf.CodedInputStream input) throws IOException
IOExceptionpublic static BackendService parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
IOExceptionpublic BackendService.Builder newBuilderForType()
newBuilderForType in interface com.google.protobuf.MessagenewBuilderForType in interface com.google.protobuf.MessageLitepublic static BackendService.Builder newBuilder()
public static BackendService.Builder newBuilder(BackendService prototype)
public BackendService.Builder toBuilder()
toBuilder in interface com.google.protobuf.MessagetoBuilder in interface com.google.protobuf.MessageLiteprotected BackendService.Builder newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
newBuilderForType in class com.google.protobuf.GeneratedMessageV3public static BackendService getDefaultInstance()
public static com.google.protobuf.Parser<BackendService> parser()
public com.google.protobuf.Parser<BackendService> getParserForType()
getParserForType in interface com.google.protobuf.MessagegetParserForType in interface com.google.protobuf.MessageLitegetParserForType in class com.google.protobuf.GeneratedMessageV3public BackendService getDefaultInstanceForType()
getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuildergetDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilderCopyright © 2023 Google LLC. All rights reserved.