Package com.google.cloud.compute.v1
Class BackendService
- java.lang.Object
-
- com.google.protobuf.AbstractMessageLite
-
- com.google.protobuf.AbstractMessage
-
- com.google.protobuf.GeneratedMessageV3
-
- com.google.cloud.compute.v1.BackendService
-
- All Implemented Interfaces:
BackendServiceOrBuilder,com.google.protobuf.Message,com.google.protobuf.MessageLite,com.google.protobuf.MessageLiteOrBuilder,com.google.protobuf.MessageOrBuilder,Serializable
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 typegoogle.cloud.compute.v1.BackendService- See Also:
- Serialized Form
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static classBackendService.BuilderRepresents a Backend Service resource.static classBackendService.CompressionModeCompress text responses using Brotli or gzip compression, based on the client's Accept-Encoding header.static classBackendService.LoadBalancingSchemeSpecifies the load balancer type.static classBackendService.LocalityLbPolicyThe load balancing algorithm used within the scope of the locality.static classBackendService.ProtocolThe protocol this BackendService uses to communicate with backends.static classBackendService.SessionAffinityType of session affinity to use.-
Nested classes/interfaces inherited from class com.google.protobuf.GeneratedMessageV3
com.google.protobuf.GeneratedMessageV3.BuilderParent, com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>,BuilderT extends com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageT,BuilderT>>, com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessageV3.ExtendableMessageOrBuilder<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessageV3.FieldAccessorTable, com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter
-
-
Field Summary
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Deprecated Methods Modifier and Type Method Description booleancontainsMetadatas(String key)Deployment metadata associated with the resource to be set by a GKE hub controller and read by the backend RCTHbooleanequals(Object obj)intgetAffinityCookieTtlSec()Lifetime of cookies in seconds.BackendgetBackends(int index)The list of backends that serve this BackendService.intgetBackendsCount()The list of backends that serve this BackendService.List<Backend>getBackendsList()The list of backends that serve this BackendService.BackendOrBuildergetBackendsOrBuilder(int index)The list of backends that serve this BackendService.List<? extends BackendOrBuilder>getBackendsOrBuilderList()The list of backends that serve this BackendService.BackendServiceCdnPolicygetCdnPolicy()Cloud CDN configuration for this BackendService.BackendServiceCdnPolicyOrBuildergetCdnPolicyOrBuilder()Cloud CDN configuration for this BackendService.CircuitBreakersgetCircuitBreakers()optional .google.cloud.compute.v1.CircuitBreakers circuit_breakers = 421340061;CircuitBreakersOrBuildergetCircuitBreakersOrBuilder()optional .google.cloud.compute.v1.CircuitBreakers circuit_breakers = 421340061;StringgetCompressionMode()Compress text responses using Brotli or gzip compression, based on the client's Accept-Encoding header.com.google.protobuf.ByteStringgetCompressionModeBytes()Compress text responses using Brotli or gzip compression, based on the client's Accept-Encoding header.ConnectionDraininggetConnectionDraining()optional .google.cloud.compute.v1.ConnectionDraining connection_draining = 461096747;ConnectionDrainingOrBuildergetConnectionDrainingOrBuilder()optional .google.cloud.compute.v1.ConnectionDraining connection_draining = 461096747;BackendServiceConnectionTrackingPolicygetConnectionTrackingPolicy()Connection Tracking configuration for this BackendService.BackendServiceConnectionTrackingPolicyOrBuildergetConnectionTrackingPolicyOrBuilder()Connection Tracking configuration for this BackendService.ConsistentHashLoadBalancerSettingsgetConsistentHash()Consistent Hash-based load balancing can be used to provide soft session affinity based on HTTP headers, cookies or other properties.ConsistentHashLoadBalancerSettingsOrBuildergetConsistentHashOrBuilder()Consistent Hash-based load balancing can be used to provide soft session affinity based on HTTP headers, cookies or other properties.StringgetCreationTimestamp()[Output Only] Creation timestamp in RFC3339 text format.com.google.protobuf.ByteStringgetCreationTimestampBytes()[Output Only] Creation timestamp in RFC3339 text format.StringgetCustomRequestHeaders(int index)Headers that the load balancer adds to proxied requests.com.google.protobuf.ByteStringgetCustomRequestHeadersBytes(int index)Headers that the load balancer adds to proxied requests.intgetCustomRequestHeadersCount()Headers that the load balancer adds to proxied requests.com.google.protobuf.ProtocolStringListgetCustomRequestHeadersList()Headers that the load balancer adds to proxied requests.StringgetCustomResponseHeaders(int index)Headers that the load balancer adds to proxied responses.com.google.protobuf.ByteStringgetCustomResponseHeadersBytes(int index)Headers that the load balancer adds to proxied responses.intgetCustomResponseHeadersCount()Headers that the load balancer adds to proxied responses.com.google.protobuf.ProtocolStringListgetCustomResponseHeadersList()Headers that the load balancer adds to proxied responses.static BackendServicegetDefaultInstance()BackendServicegetDefaultInstanceForType()StringgetDescription()An optional description of this resource.com.google.protobuf.ByteStringgetDescriptionBytes()An optional description of this resource.static com.google.protobuf.Descriptors.DescriptorgetDescriptor()StringgetEdgeSecurityPolicy()[Output Only] The resource URL for the edge security policy associated with this backend service.com.google.protobuf.ByteStringgetEdgeSecurityPolicyBytes()[Output Only] The resource URL for the edge security policy associated with this backend service.booleangetEnableCDN()If true, enables Cloud CDN for the backend service of an external HTTP(S) load balancer.BackendServiceFailoverPolicygetFailoverPolicy()Requires at least one backend instance group to be defined as a backup (failover) backend.BackendServiceFailoverPolicyOrBuildergetFailoverPolicyOrBuilder()Requires at least one backend instance group to be defined as a backup (failover) backend.StringgetFingerprint()Fingerprint of this resource.com.google.protobuf.ByteStringgetFingerprintBytes()Fingerprint of this resource.StringgetHealthChecks(int index)The list of URLs to the healthChecks, httpHealthChecks (legacy), or httpsHealthChecks (legacy) resource for health checking this backend service.com.google.protobuf.ByteStringgetHealthChecksBytes(int index)The list of URLs to the healthChecks, httpHealthChecks (legacy), or httpsHealthChecks (legacy) resource for health checking this backend service.intgetHealthChecksCount()The list of URLs to the healthChecks, httpHealthChecks (legacy), or httpsHealthChecks (legacy) resource for health checking this backend service.com.google.protobuf.ProtocolStringListgetHealthChecksList()The list of URLs to the healthChecks, httpHealthChecks (legacy), or httpsHealthChecks (legacy) resource for health checking this backend service.BackendServiceIAPgetIap()The configurations for Identity-Aware Proxy on this resource.BackendServiceIAPOrBuildergetIapOrBuilder()The configurations for Identity-Aware Proxy on this resource.longgetId()[Output Only] The unique identifier for the resource.StringgetKind()[Output Only] Type of resource.com.google.protobuf.ByteStringgetKindBytes()[Output Only] Type of resource.StringgetLoadBalancingScheme()Specifies the load balancer type.com.google.protobuf.ByteStringgetLoadBalancingSchemeBytes()Specifies the load balancer type.BackendServiceLocalityLoadBalancingPolicyConfiggetLocalityLbPolicies(int index)A list of locality load-balancing policies to be used in order of preference.intgetLocalityLbPoliciesCount()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.BackendServiceLocalityLoadBalancingPolicyConfigOrBuildergetLocalityLbPoliciesOrBuilder(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.StringgetLocalityLbPolicy()The load balancing algorithm used within the scope of the locality.com.google.protobuf.ByteStringgetLocalityLbPolicyBytes()The load balancing algorithm used within the scope of the locality.BackendServiceLogConfiggetLogConfig()This field denotes the logging options for the load balancer traffic served by this backend service.BackendServiceLogConfigOrBuildergetLogConfigOrBuilder()This field denotes the logging options for the load balancer traffic served by this backend service.DurationgetMaxStreamDuration()Specifies the default maximum duration (timeout) for streams to this service.DurationOrBuildergetMaxStreamDurationOrBuilder()Specifies the default maximum duration (timeout) for streams to this service.Map<String,String>getMetadatas()Deprecated.intgetMetadatasCount()Deployment metadata associated with the resource to be set by a GKE hub controller and read by the backend RCTHMap<String,String>getMetadatasMap()Deployment metadata associated with the resource to be set by a GKE hub controller and read by the backend RCTHStringgetMetadatasOrDefault(String key, String defaultValue)Deployment metadata associated with the resource to be set by a GKE hub controller and read by the backend RCTHStringgetMetadatasOrThrow(String key)Deployment metadata associated with the resource to be set by a GKE hub controller and read by the backend RCTHStringgetName()Name of the resource.com.google.protobuf.ByteStringgetNameBytes()Name of the resource.StringgetNetwork()The URL of the network to which this backend service belongs.com.google.protobuf.ByteStringgetNetworkBytes()The URL of the network to which this backend service belongs.OutlierDetectiongetOutlierDetection()Settings controlling the ejection of unhealthy backend endpoints from the load balancing pool of each individual proxy instance that processes the traffic for the given backend service.OutlierDetectionOrBuildergetOutlierDetectionOrBuilder()Settings controlling the ejection of unhealthy backend endpoints from the load balancing pool of each individual proxy instance that processes the traffic for the given backend service.com.google.protobuf.Parser<BackendService>getParserForType()intgetPort()Deprecated in favor of portName.StringgetPortName()A named port on a backend instance group representing the port for communication to the backend VMs in that group.com.google.protobuf.ByteStringgetPortNameBytes()A named port on a backend instance group representing the port for communication to the backend VMs in that group.StringgetProtocol()The protocol this BackendService uses to communicate with backends.com.google.protobuf.ByteStringgetProtocolBytes()The protocol this BackendService uses to communicate with backends.StringgetRegion()[Output Only] URL of the region where the regional backend service resides.com.google.protobuf.ByteStringgetRegionBytes()[Output Only] URL of the region where the regional backend service resides.StringgetSecurityPolicy()[Output Only] The resource URL for the security policy associated with this backend service.com.google.protobuf.ByteStringgetSecurityPolicyBytes()[Output Only] The resource URL for the security policy associated with this backend service.SecuritySettingsgetSecuritySettings()This field specifies the security settings that apply to this backend service.SecuritySettingsOrBuildergetSecuritySettingsOrBuilder()This field specifies the security settings that apply to this backend service.StringgetSelfLink()[Output Only] Server-defined URL for the resource.com.google.protobuf.ByteStringgetSelfLinkBytes()[Output Only] Server-defined URL for the resource.intgetSerializedSize()StringgetServiceBindings(int index)URLs of networkservices.ServiceBinding resources.com.google.protobuf.ByteStringgetServiceBindingsBytes(int index)URLs of networkservices.ServiceBinding resources.intgetServiceBindingsCount()URLs of networkservices.ServiceBinding resources.com.google.protobuf.ProtocolStringListgetServiceBindingsList()URLs of networkservices.ServiceBinding resources.StringgetSessionAffinity()Type of session affinity to use.com.google.protobuf.ByteStringgetSessionAffinityBytes()Type of session affinity to use.SubsettinggetSubsetting()optional .google.cloud.compute.v1.Subsetting subsetting = 450283536;SubsettingOrBuildergetSubsettingOrBuilder()optional .google.cloud.compute.v1.Subsetting subsetting = 450283536;intgetTimeoutSec()The backend service timeout has a different meaning depending on the type of load balancer.booleanhasAffinityCookieTtlSec()Lifetime of cookies in seconds.booleanhasCdnPolicy()Cloud CDN configuration for this BackendService.booleanhasCircuitBreakers()optional .google.cloud.compute.v1.CircuitBreakers circuit_breakers = 421340061;booleanhasCompressionMode()Compress text responses using Brotli or gzip compression, based on the client's Accept-Encoding header.booleanhasConnectionDraining()optional .google.cloud.compute.v1.ConnectionDraining connection_draining = 461096747;booleanhasConnectionTrackingPolicy()Connection Tracking configuration for this BackendService.booleanhasConsistentHash()Consistent Hash-based load balancing can be used to provide soft session affinity based on HTTP headers, cookies or other properties.booleanhasCreationTimestamp()[Output Only] Creation timestamp in RFC3339 text format.booleanhasDescription()An optional description of this resource.booleanhasEdgeSecurityPolicy()[Output Only] The resource URL for the edge security policy associated with this backend service.booleanhasEnableCDN()If true, enables Cloud CDN for the backend service of an external HTTP(S) load balancer.booleanhasFailoverPolicy()Requires at least one backend instance group to be defined as a backup (failover) backend.booleanhasFingerprint()Fingerprint of this resource.inthashCode()booleanhasIap()The configurations for Identity-Aware Proxy on this resource.booleanhasId()[Output Only] The unique identifier for the resource.booleanhasKind()[Output Only] Type of resource.booleanhasLoadBalancingScheme()Specifies the load balancer type.booleanhasLocalityLbPolicy()The load balancing algorithm used within the scope of the locality.booleanhasLogConfig()This field denotes the logging options for the load balancer traffic served by this backend service.booleanhasMaxStreamDuration()Specifies the default maximum duration (timeout) for streams to this service.booleanhasName()Name of the resource.booleanhasNetwork()The URL of the network to which this backend service belongs.booleanhasOutlierDetection()Settings controlling the ejection of unhealthy backend endpoints from the load balancing pool of each individual proxy instance that processes the traffic for the given backend service.booleanhasPort()Deprecated in favor of portName.booleanhasPortName()A named port on a backend instance group representing the port for communication to the backend VMs in that group.booleanhasProtocol()The protocol this BackendService uses to communicate with backends.booleanhasRegion()[Output Only] URL of the region where the regional backend service resides.booleanhasSecurityPolicy()[Output Only] The resource URL for the security policy associated with this backend service.booleanhasSecuritySettings()This field specifies the security settings that apply to this backend service.booleanhasSelfLink()[Output Only] Server-defined URL for the resource.booleanhasSessionAffinity()Type of session affinity to use.booleanhasSubsetting()optional .google.cloud.compute.v1.Subsetting subsetting = 450283536;booleanhasTimeoutSec()The backend service timeout has a different meaning depending on the type of load balancer.protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTableinternalGetFieldAccessorTable()protected com.google.protobuf.MapFieldinternalGetMapField(int number)booleanisInitialized()static BackendService.BuildernewBuilder()static BackendService.BuildernewBuilder(BackendService prototype)BackendService.BuildernewBuilderForType()protected BackendService.BuildernewBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)protected ObjectnewInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)static BackendServiceparseDelimitedFrom(InputStream input)static BackendServiceparseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)static BackendServiceparseFrom(byte[] data)static BackendServiceparseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)static BackendServiceparseFrom(com.google.protobuf.ByteString data)static BackendServiceparseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)static BackendServiceparseFrom(com.google.protobuf.CodedInputStream input)static BackendServiceparseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)static BackendServiceparseFrom(InputStream input)static BackendServiceparseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)static BackendServiceparseFrom(ByteBuffer data)static BackendServiceparseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)static com.google.protobuf.Parser<BackendService>parser()BackendService.BuildertoBuilder()voidwriteTo(com.google.protobuf.CodedOutputStream output)-
Methods inherited from class com.google.protobuf.GeneratedMessageV3
canUseUnsafe, computeStringSize, computeStringSizeNoTag, emptyBooleanList, emptyDoubleList, emptyFloatList, emptyIntList, emptyLongList, getAllFields, getDescriptorForType, getField, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof, isStringEmpty, makeExtensionsImmutable, makeMutableCopy, 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, writeStringNoTag
-
Methods inherited from class com.google.protobuf.AbstractMessage
findInitializationErrors, getInitializationErrorString, hashBoolean, hashEnum, hashEnumList, hashFields, hashLong, toString
-
Methods inherited from class com.google.protobuf.AbstractMessageLite
addAll, addAll, checkByteStringIsUtf8, toByteArray, toByteString, writeDelimitedTo, writeTo
-
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
-
-
-
-
Field Detail
-
AFFINITY_COOKIE_TTL_SEC_FIELD_NUMBER
public static final int AFFINITY_COOKIE_TTL_SEC_FIELD_NUMBER
- See Also:
- Constant Field Values
-
BACKENDS_FIELD_NUMBER
public static final int BACKENDS_FIELD_NUMBER
- See Also:
- Constant Field Values
-
CDN_POLICY_FIELD_NUMBER
public static final int CDN_POLICY_FIELD_NUMBER
- See Also:
- Constant Field Values
-
CIRCUIT_BREAKERS_FIELD_NUMBER
public static final int CIRCUIT_BREAKERS_FIELD_NUMBER
- See Also:
- Constant Field Values
-
COMPRESSION_MODE_FIELD_NUMBER
public static final int COMPRESSION_MODE_FIELD_NUMBER
- See Also:
- Constant Field Values
-
CONNECTION_DRAINING_FIELD_NUMBER
public static final int CONNECTION_DRAINING_FIELD_NUMBER
- See Also:
- Constant Field Values
-
CONNECTION_TRACKING_POLICY_FIELD_NUMBER
public static final int CONNECTION_TRACKING_POLICY_FIELD_NUMBER
- See Also:
- Constant Field Values
-
CONSISTENT_HASH_FIELD_NUMBER
public static final int CONSISTENT_HASH_FIELD_NUMBER
- See Also:
- Constant Field Values
-
CREATION_TIMESTAMP_FIELD_NUMBER
public static final int CREATION_TIMESTAMP_FIELD_NUMBER
- See Also:
- Constant Field Values
-
CUSTOM_REQUEST_HEADERS_FIELD_NUMBER
public static final int CUSTOM_REQUEST_HEADERS_FIELD_NUMBER
- See Also:
- Constant Field Values
-
CUSTOM_RESPONSE_HEADERS_FIELD_NUMBER
public static final int CUSTOM_RESPONSE_HEADERS_FIELD_NUMBER
- See Also:
- Constant Field Values
-
DESCRIPTION_FIELD_NUMBER
public static final int DESCRIPTION_FIELD_NUMBER
- See Also:
- Constant Field Values
-
EDGE_SECURITY_POLICY_FIELD_NUMBER
public static final int EDGE_SECURITY_POLICY_FIELD_NUMBER
- See Also:
- Constant Field Values
-
ENABLE_C_D_N_FIELD_NUMBER
public static final int ENABLE_C_D_N_FIELD_NUMBER
- See Also:
- Constant Field Values
-
FAILOVER_POLICY_FIELD_NUMBER
public static final int FAILOVER_POLICY_FIELD_NUMBER
- See Also:
- Constant Field Values
-
FINGERPRINT_FIELD_NUMBER
public static final int FINGERPRINT_FIELD_NUMBER
- See Also:
- Constant Field Values
-
HEALTH_CHECKS_FIELD_NUMBER
public static final int HEALTH_CHECKS_FIELD_NUMBER
- See Also:
- Constant Field Values
-
IAP_FIELD_NUMBER
public static final int IAP_FIELD_NUMBER
- See Also:
- Constant Field Values
-
ID_FIELD_NUMBER
public static final int ID_FIELD_NUMBER
- See Also:
- Constant Field Values
-
KIND_FIELD_NUMBER
public static final int KIND_FIELD_NUMBER
- See Also:
- Constant Field Values
-
LOAD_BALANCING_SCHEME_FIELD_NUMBER
public static final int LOAD_BALANCING_SCHEME_FIELD_NUMBER
- See Also:
- Constant Field Values
-
LOCALITY_LB_POLICIES_FIELD_NUMBER
public static final int LOCALITY_LB_POLICIES_FIELD_NUMBER
- See Also:
- Constant Field Values
-
LOCALITY_LB_POLICY_FIELD_NUMBER
public static final int LOCALITY_LB_POLICY_FIELD_NUMBER
- See Also:
- Constant Field Values
-
LOG_CONFIG_FIELD_NUMBER
public static final int LOG_CONFIG_FIELD_NUMBER
- See Also:
- Constant Field Values
-
MAX_STREAM_DURATION_FIELD_NUMBER
public static final int MAX_STREAM_DURATION_FIELD_NUMBER
- See Also:
- Constant Field Values
-
METADATAS_FIELD_NUMBER
public static final int METADATAS_FIELD_NUMBER
- See Also:
- Constant Field Values
-
NAME_FIELD_NUMBER
public static final int NAME_FIELD_NUMBER
- See Also:
- Constant Field Values
-
NETWORK_FIELD_NUMBER
public static final int NETWORK_FIELD_NUMBER
- See Also:
- Constant Field Values
-
OUTLIER_DETECTION_FIELD_NUMBER
public static final int OUTLIER_DETECTION_FIELD_NUMBER
- See Also:
- Constant Field Values
-
PORT_FIELD_NUMBER
public static final int PORT_FIELD_NUMBER
- See Also:
- Constant Field Values
-
PORT_NAME_FIELD_NUMBER
public static final int PORT_NAME_FIELD_NUMBER
- See Also:
- Constant Field Values
-
PROTOCOL_FIELD_NUMBER
public static final int PROTOCOL_FIELD_NUMBER
- See Also:
- Constant Field Values
-
REGION_FIELD_NUMBER
public static final int REGION_FIELD_NUMBER
- See Also:
- Constant Field Values
-
SECURITY_POLICY_FIELD_NUMBER
public static final int SECURITY_POLICY_FIELD_NUMBER
- See Also:
- Constant Field Values
-
SECURITY_SETTINGS_FIELD_NUMBER
public static final int SECURITY_SETTINGS_FIELD_NUMBER
- See Also:
- Constant Field Values
-
SELF_LINK_FIELD_NUMBER
public static final int SELF_LINK_FIELD_NUMBER
- See Also:
- Constant Field Values
-
SERVICE_BINDINGS_FIELD_NUMBER
public static final int SERVICE_BINDINGS_FIELD_NUMBER
- See Also:
- Constant Field Values
-
SESSION_AFFINITY_FIELD_NUMBER
public static final int SESSION_AFFINITY_FIELD_NUMBER
- See Also:
- Constant Field Values
-
SUBSETTING_FIELD_NUMBER
public static final int SUBSETTING_FIELD_NUMBER
- See Also:
- Constant Field Values
-
TIMEOUT_SEC_FIELD_NUMBER
public static final int TIMEOUT_SEC_FIELD_NUMBER
- See Also:
- Constant Field Values
-
-
Method Detail
-
newInstance
protected Object newInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)
- Overrides:
newInstancein classcom.google.protobuf.GeneratedMessageV3
-
getDescriptor
public static final com.google.protobuf.Descriptors.Descriptor getDescriptor()
-
internalGetMapField
protected com.google.protobuf.MapField internalGetMapField(int number)
- Overrides:
internalGetMapFieldin classcom.google.protobuf.GeneratedMessageV3
-
internalGetFieldAccessorTable
protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
- Specified by:
internalGetFieldAccessorTablein classcom.google.protobuf.GeneratedMessageV3
-
hasAffinityCookieTtlSec
public 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;- Specified by:
hasAffinityCookieTtlSecin interfaceBackendServiceOrBuilder- Returns:
- Whether the affinityCookieTtlSec field is set.
-
getAffinityCookieTtlSec
public 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;- Specified by:
getAffinityCookieTtlSecin interfaceBackendServiceOrBuilder- Returns:
- The affinityCookieTtlSec.
-
getBackendsList
public List<Backend> getBackendsList()
The list of backends that serve this BackendService.
repeated .google.cloud.compute.v1.Backend backends = 510839903;- Specified by:
getBackendsListin interfaceBackendServiceOrBuilder
-
getBackendsOrBuilderList
public List<? extends BackendOrBuilder> getBackendsOrBuilderList()
The list of backends that serve this BackendService.
repeated .google.cloud.compute.v1.Backend backends = 510839903;- Specified by:
getBackendsOrBuilderListin interfaceBackendServiceOrBuilder
-
getBackendsCount
public int getBackendsCount()
The list of backends that serve this BackendService.
repeated .google.cloud.compute.v1.Backend backends = 510839903;- Specified by:
getBackendsCountin interfaceBackendServiceOrBuilder
-
getBackends
public Backend getBackends(int index)
The list of backends that serve this BackendService.
repeated .google.cloud.compute.v1.Backend backends = 510839903;- Specified by:
getBackendsin interfaceBackendServiceOrBuilder
-
getBackendsOrBuilder
public BackendOrBuilder getBackendsOrBuilder(int index)
The list of backends that serve this BackendService.
repeated .google.cloud.compute.v1.Backend backends = 510839903;- Specified by:
getBackendsOrBuilderin interfaceBackendServiceOrBuilder
-
hasCdnPolicy
public boolean hasCdnPolicy()
Cloud CDN configuration for this BackendService. Only available for specified load balancer types.
optional .google.cloud.compute.v1.BackendServiceCdnPolicy cdn_policy = 213976452;- Specified by:
hasCdnPolicyin interfaceBackendServiceOrBuilder- Returns:
- Whether the cdnPolicy field is set.
-
getCdnPolicy
public BackendServiceCdnPolicy getCdnPolicy()
Cloud CDN configuration for this BackendService. Only available for specified load balancer types.
optional .google.cloud.compute.v1.BackendServiceCdnPolicy cdn_policy = 213976452;- Specified by:
getCdnPolicyin interfaceBackendServiceOrBuilder- Returns:
- The cdnPolicy.
-
getCdnPolicyOrBuilder
public BackendServiceCdnPolicyOrBuilder getCdnPolicyOrBuilder()
Cloud CDN configuration for this BackendService. Only available for specified load balancer types.
optional .google.cloud.compute.v1.BackendServiceCdnPolicy cdn_policy = 213976452;- Specified by:
getCdnPolicyOrBuilderin interfaceBackendServiceOrBuilder
-
hasCircuitBreakers
public boolean hasCircuitBreakers()
optional .google.cloud.compute.v1.CircuitBreakers circuit_breakers = 421340061;- Specified by:
hasCircuitBreakersin interfaceBackendServiceOrBuilder- Returns:
- Whether the circuitBreakers field is set.
-
getCircuitBreakers
public CircuitBreakers getCircuitBreakers()
optional .google.cloud.compute.v1.CircuitBreakers circuit_breakers = 421340061;- Specified by:
getCircuitBreakersin interfaceBackendServiceOrBuilder- Returns:
- The circuitBreakers.
-
getCircuitBreakersOrBuilder
public CircuitBreakersOrBuilder getCircuitBreakersOrBuilder()
optional .google.cloud.compute.v1.CircuitBreakers circuit_breakers = 421340061;- Specified by:
getCircuitBreakersOrBuilderin interfaceBackendServiceOrBuilder
-
hasCompressionMode
public 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;- Specified by:
hasCompressionModein interfaceBackendServiceOrBuilder- Returns:
- Whether the compressionMode field is set.
-
getCompressionMode
public 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;- Specified by:
getCompressionModein interfaceBackendServiceOrBuilder- Returns:
- The compressionMode.
-
getCompressionModeBytes
public 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;- Specified by:
getCompressionModeBytesin interfaceBackendServiceOrBuilder- Returns:
- The bytes for compressionMode.
-
hasConnectionDraining
public boolean hasConnectionDraining()
optional .google.cloud.compute.v1.ConnectionDraining connection_draining = 461096747;- Specified by:
hasConnectionDrainingin interfaceBackendServiceOrBuilder- Returns:
- Whether the connectionDraining field is set.
-
getConnectionDraining
public ConnectionDraining getConnectionDraining()
optional .google.cloud.compute.v1.ConnectionDraining connection_draining = 461096747;- Specified by:
getConnectionDrainingin interfaceBackendServiceOrBuilder- Returns:
- The connectionDraining.
-
getConnectionDrainingOrBuilder
public ConnectionDrainingOrBuilder getConnectionDrainingOrBuilder()
optional .google.cloud.compute.v1.ConnectionDraining connection_draining = 461096747;- Specified by:
getConnectionDrainingOrBuilderin interfaceBackendServiceOrBuilder
-
hasConnectionTrackingPolicy
public 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;- Specified by:
hasConnectionTrackingPolicyin interfaceBackendServiceOrBuilder- Returns:
- Whether the connectionTrackingPolicy field is set.
-
getConnectionTrackingPolicy
public 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;- Specified by:
getConnectionTrackingPolicyin interfaceBackendServiceOrBuilder- Returns:
- The connectionTrackingPolicy.
-
getConnectionTrackingPolicyOrBuilder
public 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;- Specified by:
getConnectionTrackingPolicyOrBuilderin interfaceBackendServiceOrBuilder
-
hasConsistentHash
public 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;- Specified by:
hasConsistentHashin interfaceBackendServiceOrBuilder- Returns:
- Whether the consistentHash field is set.
-
getConsistentHash
public 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;- Specified by:
getConsistentHashin interfaceBackendServiceOrBuilder- Returns:
- The consistentHash.
-
getConsistentHashOrBuilder
public 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;- Specified by:
getConsistentHashOrBuilderin interfaceBackendServiceOrBuilder
-
hasCreationTimestamp
public boolean hasCreationTimestamp()
[Output Only] Creation timestamp in RFC3339 text format.
optional string creation_timestamp = 30525366;- Specified by:
hasCreationTimestampin interfaceBackendServiceOrBuilder- Returns:
- Whether the creationTimestamp field is set.
-
getCreationTimestamp
public String getCreationTimestamp()
[Output Only] Creation timestamp in RFC3339 text format.
optional string creation_timestamp = 30525366;- Specified by:
getCreationTimestampin interfaceBackendServiceOrBuilder- Returns:
- The creationTimestamp.
-
getCreationTimestampBytes
public com.google.protobuf.ByteString getCreationTimestampBytes()
[Output Only] Creation timestamp in RFC3339 text format.
optional string creation_timestamp = 30525366;- Specified by:
getCreationTimestampBytesin interfaceBackendServiceOrBuilder- Returns:
- The bytes for creationTimestamp.
-
getCustomRequestHeadersList
public 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;- Specified by:
getCustomRequestHeadersListin interfaceBackendServiceOrBuilder- Returns:
- A list containing the customRequestHeaders.
-
getCustomRequestHeadersCount
public 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;- Specified by:
getCustomRequestHeadersCountin interfaceBackendServiceOrBuilder- Returns:
- The count of customRequestHeaders.
-
getCustomRequestHeaders
public 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;- Specified by:
getCustomRequestHeadersin interfaceBackendServiceOrBuilder- Parameters:
index- The index of the element to return.- Returns:
- The customRequestHeaders at the given index.
-
getCustomRequestHeadersBytes
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;- Specified by:
getCustomRequestHeadersBytesin interfaceBackendServiceOrBuilder- Parameters:
index- The index of the value to return.- Returns:
- The bytes of the customRequestHeaders at the given index.
-
getCustomResponseHeadersList
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;- Specified by:
getCustomResponseHeadersListin interfaceBackendServiceOrBuilder- Returns:
- A list containing the customResponseHeaders.
-
getCustomResponseHeadersCount
public 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;- Specified by:
getCustomResponseHeadersCountin interfaceBackendServiceOrBuilder- Returns:
- The count of customResponseHeaders.
-
getCustomResponseHeaders
public 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;- Specified by:
getCustomResponseHeadersin interfaceBackendServiceOrBuilder- Parameters:
index- The index of the element to return.- Returns:
- The customResponseHeaders at the given index.
-
getCustomResponseHeadersBytes
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;- Specified by:
getCustomResponseHeadersBytesin interfaceBackendServiceOrBuilder- Parameters:
index- The index of the value to return.- Returns:
- The bytes of the customResponseHeaders at the given index.
-
hasDescription
public boolean hasDescription()
An optional description of this resource. Provide this property when you create the resource.
optional string description = 422937596;- Specified by:
hasDescriptionin interfaceBackendServiceOrBuilder- Returns:
- Whether the description field is set.
-
getDescription
public String getDescription()
An optional description of this resource. Provide this property when you create the resource.
optional string description = 422937596;- Specified by:
getDescriptionin interfaceBackendServiceOrBuilder- Returns:
- The description.
-
getDescriptionBytes
public com.google.protobuf.ByteString getDescriptionBytes()
An optional description of this resource. Provide this property when you create the resource.
optional string description = 422937596;- Specified by:
getDescriptionBytesin interfaceBackendServiceOrBuilder- Returns:
- The bytes for description.
-
hasEdgeSecurityPolicy
public boolean hasEdgeSecurityPolicy()
[Output Only] The resource URL for the edge security policy associated with this backend service.
optional string edge_security_policy = 41036943;- Specified by:
hasEdgeSecurityPolicyin interfaceBackendServiceOrBuilder- Returns:
- Whether the edgeSecurityPolicy field is set.
-
getEdgeSecurityPolicy
public String getEdgeSecurityPolicy()
[Output Only] The resource URL for the edge security policy associated with this backend service.
optional string edge_security_policy = 41036943;- Specified by:
getEdgeSecurityPolicyin interfaceBackendServiceOrBuilder- Returns:
- The edgeSecurityPolicy.
-
getEdgeSecurityPolicyBytes
public 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;- Specified by:
getEdgeSecurityPolicyBytesin interfaceBackendServiceOrBuilder- Returns:
- The bytes for edgeSecurityPolicy.
-
hasEnableCDN
public 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;- Specified by:
hasEnableCDNin interfaceBackendServiceOrBuilder- Returns:
- Whether the enableCDN field is set.
-
getEnableCDN
public 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;- Specified by:
getEnableCDNin interfaceBackendServiceOrBuilder- Returns:
- The enableCDN.
-
hasFailoverPolicy
public 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;- Specified by:
hasFailoverPolicyin interfaceBackendServiceOrBuilder- Returns:
- Whether the failoverPolicy field is set.
-
getFailoverPolicy
public 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;- Specified by:
getFailoverPolicyin interfaceBackendServiceOrBuilder- Returns:
- The failoverPolicy.
-
getFailoverPolicyOrBuilder
public 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;- Specified by:
getFailoverPolicyOrBuilderin interfaceBackendServiceOrBuilder
-
hasFingerprint
public 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;- Specified by:
hasFingerprintin interfaceBackendServiceOrBuilder- Returns:
- Whether the fingerprint field is set.
-
getFingerprint
public 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;- Specified by:
getFingerprintin interfaceBackendServiceOrBuilder- Returns:
- The fingerprint.
-
getFingerprintBytes
public 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;- Specified by:
getFingerprintBytesin interfaceBackendServiceOrBuilder- Returns:
- The bytes for fingerprint.
-
getHealthChecksList
public 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;- Specified by:
getHealthChecksListin interfaceBackendServiceOrBuilder- Returns:
- A list containing the healthChecks.
-
getHealthChecksCount
public 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;- Specified by:
getHealthChecksCountin interfaceBackendServiceOrBuilder- Returns:
- The count of healthChecks.
-
getHealthChecks
public 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;- Specified by:
getHealthChecksin interfaceBackendServiceOrBuilder- Parameters:
index- The index of the element to return.- Returns:
- The healthChecks at the given index.
-
getHealthChecksBytes
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;- Specified by:
getHealthChecksBytesin interfaceBackendServiceOrBuilder- Parameters:
index- The index of the value to return.- Returns:
- The bytes of the healthChecks at the given index.
-
hasIap
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;- Specified by:
hasIapin interfaceBackendServiceOrBuilder- Returns:
- Whether the iap field is set.
-
getIap
public 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;- Specified by:
getIapin interfaceBackendServiceOrBuilder- Returns:
- The iap.
-
getIapOrBuilder
public 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;- Specified by:
getIapOrBuilderin interfaceBackendServiceOrBuilder
-
hasId
public boolean hasId()
[Output Only] The unique identifier for the resource. This identifier is defined by the server.
optional uint64 id = 3355;- Specified by:
hasIdin interfaceBackendServiceOrBuilder- Returns:
- Whether the id field is set.
-
getId
public long getId()
[Output Only] The unique identifier for the resource. This identifier is defined by the server.
optional uint64 id = 3355;- Specified by:
getIdin interfaceBackendServiceOrBuilder- Returns:
- The id.
-
hasKind
public boolean hasKind()
[Output Only] Type of resource. Always compute#backendService for backend services.
optional string kind = 3292052;- Specified by:
hasKindin interfaceBackendServiceOrBuilder- Returns:
- Whether the kind field is set.
-
getKind
public String getKind()
[Output Only] Type of resource. Always compute#backendService for backend services.
optional string kind = 3292052;- Specified by:
getKindin interfaceBackendServiceOrBuilder- Returns:
- The kind.
-
getKindBytes
public com.google.protobuf.ByteString getKindBytes()
[Output Only] Type of resource. Always compute#backendService for backend services.
optional string kind = 3292052;- Specified by:
getKindBytesin interfaceBackendServiceOrBuilder- Returns:
- The bytes for kind.
-
hasLoadBalancingScheme
public 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;- Specified by:
hasLoadBalancingSchemein interfaceBackendServiceOrBuilder- Returns:
- Whether the loadBalancingScheme field is set.
-
getLoadBalancingScheme
public 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;- Specified by:
getLoadBalancingSchemein interfaceBackendServiceOrBuilder- Returns:
- The loadBalancingScheme.
-
getLoadBalancingSchemeBytes
public 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;- Specified by:
getLoadBalancingSchemeBytesin interfaceBackendServiceOrBuilder- Returns:
- The bytes for loadBalancingScheme.
-
getLocalityLbPoliciesList
public List<BackendServiceLocalityLoadBalancingPolicyConfig> getLocalityLbPoliciesList()
A list of locality load-balancing policies to be used in order of preference. When you use localityLbPolicies, you must set at least one value for either the localityLbPolicies[].policy or the localityLbPolicies[].customPolicy field. localityLbPolicies overrides any value set in the localityLbPolicy field. For an example of how to use this field, see Define a list of preferred policies. Caution: This field and its children are intended for use in a service mesh that includes gRPC clients only. Envoy proxies can't use backend services that have this configuration.
repeated .google.cloud.compute.v1.BackendServiceLocalityLoadBalancingPolicyConfig locality_lb_policies = 140982557;- Specified by:
getLocalityLbPoliciesListin interfaceBackendServiceOrBuilder
-
getLocalityLbPoliciesOrBuilderList
public List<? extends BackendServiceLocalityLoadBalancingPolicyConfigOrBuilder> getLocalityLbPoliciesOrBuilderList()
A list of locality load-balancing policies to be used in order of preference. When you use localityLbPolicies, you must set at least one value for either the localityLbPolicies[].policy or the localityLbPolicies[].customPolicy field. localityLbPolicies overrides any value set in the localityLbPolicy field. For an example of how to use this field, see Define a list of preferred policies. Caution: This field and its children are intended for use in a service mesh that includes gRPC clients only. Envoy proxies can't use backend services that have this configuration.
repeated .google.cloud.compute.v1.BackendServiceLocalityLoadBalancingPolicyConfig locality_lb_policies = 140982557;- Specified by:
getLocalityLbPoliciesOrBuilderListin interfaceBackendServiceOrBuilder
-
getLocalityLbPoliciesCount
public int getLocalityLbPoliciesCount()
A list of locality load-balancing policies to be used in order of preference. When you use localityLbPolicies, you must set at least one value for either the localityLbPolicies[].policy or the localityLbPolicies[].customPolicy field. localityLbPolicies overrides any value set in the localityLbPolicy field. For an example of how to use this field, see Define a list of preferred policies. Caution: This field and its children are intended for use in a service mesh that includes gRPC clients only. Envoy proxies can't use backend services that have this configuration.
repeated .google.cloud.compute.v1.BackendServiceLocalityLoadBalancingPolicyConfig locality_lb_policies = 140982557;- Specified by:
getLocalityLbPoliciesCountin interfaceBackendServiceOrBuilder
-
getLocalityLbPolicies
public BackendServiceLocalityLoadBalancingPolicyConfig getLocalityLbPolicies(int index)
A list of locality load-balancing policies to be used in order of preference. When you use localityLbPolicies, you must set at least one value for either the localityLbPolicies[].policy or the localityLbPolicies[].customPolicy field. localityLbPolicies overrides any value set in the localityLbPolicy field. For an example of how to use this field, see Define a list of preferred policies. Caution: This field and its children are intended for use in a service mesh that includes gRPC clients only. Envoy proxies can't use backend services that have this configuration.
repeated .google.cloud.compute.v1.BackendServiceLocalityLoadBalancingPolicyConfig locality_lb_policies = 140982557;- Specified by:
getLocalityLbPoliciesin interfaceBackendServiceOrBuilder
-
getLocalityLbPoliciesOrBuilder
public BackendServiceLocalityLoadBalancingPolicyConfigOrBuilder getLocalityLbPoliciesOrBuilder(int index)
A list of locality load-balancing policies to be used in order of preference. When you use localityLbPolicies, you must set at least one value for either the localityLbPolicies[].policy or the localityLbPolicies[].customPolicy field. localityLbPolicies overrides any value set in the localityLbPolicy field. For an example of how to use this field, see Define a list of preferred policies. Caution: This field and its children are intended for use in a service mesh that includes gRPC clients only. Envoy proxies can't use backend services that have this configuration.
repeated .google.cloud.compute.v1.BackendServiceLocalityLoadBalancingPolicyConfig locality_lb_policies = 140982557;- Specified by:
getLocalityLbPoliciesOrBuilderin interfaceBackendServiceOrBuilder
-
hasLocalityLbPolicy
public 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;- Specified by:
hasLocalityLbPolicyin interfaceBackendServiceOrBuilder- Returns:
- Whether the localityLbPolicy field is set.
-
getLocalityLbPolicy
public 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;- Specified by:
getLocalityLbPolicyin interfaceBackendServiceOrBuilder- Returns:
- The localityLbPolicy.
-
getLocalityLbPolicyBytes
public 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;- Specified by:
getLocalityLbPolicyBytesin interfaceBackendServiceOrBuilder- Returns:
- The bytes for localityLbPolicy.
-
hasLogConfig
public 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;- Specified by:
hasLogConfigin interfaceBackendServiceOrBuilder- Returns:
- Whether the logConfig field is set.
-
getLogConfig
public 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;- Specified by:
getLogConfigin interfaceBackendServiceOrBuilder- Returns:
- The logConfig.
-
getLogConfigOrBuilder
public 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;- Specified by:
getLogConfigOrBuilderin interfaceBackendServiceOrBuilder
-
hasMaxStreamDuration
public 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;- Specified by:
hasMaxStreamDurationin interfaceBackendServiceOrBuilder- Returns:
- Whether the maxStreamDuration field is set.
-
getMaxStreamDuration
public 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;- Specified by:
getMaxStreamDurationin interfaceBackendServiceOrBuilder- Returns:
- The maxStreamDuration.
-
getMaxStreamDurationOrBuilder
public 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;- Specified by:
getMaxStreamDurationOrBuilderin interfaceBackendServiceOrBuilder
-
getMetadatasCount
public int getMetadatasCount()
Description copied from interface:BackendServiceOrBuilderDeployment metadata associated with the resource to be set by a GKE hub controller and read by the backend RCTH
map<string, string> metadatas = 8514340;- Specified by:
getMetadatasCountin interfaceBackendServiceOrBuilder
-
containsMetadatas
public boolean containsMetadatas(String key)
Deployment metadata associated with the resource to be set by a GKE hub controller and read by the backend RCTH
map<string, string> metadatas = 8514340;- Specified by:
containsMetadatasin interfaceBackendServiceOrBuilder
-
getMetadatas
@Deprecated public Map<String,String> getMetadatas()
Deprecated.UsegetMetadatasMap()instead.- Specified by:
getMetadatasin interfaceBackendServiceOrBuilder
-
getMetadatasMap
public Map<String,String> getMetadatasMap()
Deployment metadata associated with the resource to be set by a GKE hub controller and read by the backend RCTH
map<string, string> metadatas = 8514340;- Specified by:
getMetadatasMapin interfaceBackendServiceOrBuilder
-
getMetadatasOrDefault
public String getMetadatasOrDefault(String key, String defaultValue)
Deployment metadata associated with the resource to be set by a GKE hub controller and read by the backend RCTH
map<string, string> metadatas = 8514340;- Specified by:
getMetadatasOrDefaultin interfaceBackendServiceOrBuilder
-
getMetadatasOrThrow
public String getMetadatasOrThrow(String key)
Deployment metadata associated with the resource to be set by a GKE hub controller and read by the backend RCTH
map<string, string> metadatas = 8514340;- Specified by:
getMetadatasOrThrowin interfaceBackendServiceOrBuilder
-
hasName
public 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;- Specified by:
hasNamein interfaceBackendServiceOrBuilder- Returns:
- Whether the name field is set.
-
getName
public 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;- Specified by:
getNamein interfaceBackendServiceOrBuilder- Returns:
- The name.
-
getNameBytes
public 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;- Specified by:
getNameBytesin interfaceBackendServiceOrBuilder- Returns:
- The bytes for name.
-
hasNetwork
public 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;- Specified by:
hasNetworkin interfaceBackendServiceOrBuilder- Returns:
- Whether the network field is set.
-
getNetwork
public 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;- Specified by:
getNetworkin interfaceBackendServiceOrBuilder- Returns:
- The network.
-
getNetworkBytes
public 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;- Specified by:
getNetworkBytesin interfaceBackendServiceOrBuilder- Returns:
- The bytes for network.
-
hasOutlierDetection
public boolean hasOutlierDetection()
Settings controlling the ejection of unhealthy backend endpoints from the load balancing pool of each individual proxy instance that processes the traffic for the given backend service. If not set, this feature is considered disabled. Results of the outlier detection algorithm (ejection of endpoints from the load balancing pool and returning them back to the pool) are executed independently by each proxy instance of the load balancer. In most cases, more than one proxy instance handles the traffic received by a backend service. Thus, it is possible that an unhealthy endpoint is detected and ejected by only some of the proxies, and while this happens, other proxies may continue to send requests to the same unhealthy endpoint until they detect and eject the unhealthy endpoint. Applicable backend endpoints can be: - VM instances in an Instance Group - Endpoints in a Zonal NEG (GCE_VM_IP, GCE_VM_IP_PORT) - Endpoints in a Hybrid Connectivity NEG (NON_GCP_PRIVATE_IP_PORT) - Serverless NEGs, that resolve to Cloud Run, App Engine, or Cloud Functions Services - Private Service Connect NEGs, that resolve to Google-managed regional API endpoints or managed services published using Private Service Connect Applicable backend service types can be: - A global backend service with the loadBalancingScheme set to INTERNAL_SELF_MANAGED or EXTERNAL_MANAGED. - A regional backend service with the serviceProtocol set to HTTP, HTTPS, or HTTP2, and loadBalancingScheme set to INTERNAL_MANAGED or EXTERNAL_MANAGED. Not supported for Serverless NEGs. 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 .google.cloud.compute.v1.OutlierDetection outlier_detection = 354625086;- Specified by:
hasOutlierDetectionin interfaceBackendServiceOrBuilder- Returns:
- Whether the outlierDetection field is set.
-
getOutlierDetection
public OutlierDetection getOutlierDetection()
Settings controlling the ejection of unhealthy backend endpoints from the load balancing pool of each individual proxy instance that processes the traffic for the given backend service. If not set, this feature is considered disabled. Results of the outlier detection algorithm (ejection of endpoints from the load balancing pool and returning them back to the pool) are executed independently by each proxy instance of the load balancer. In most cases, more than one proxy instance handles the traffic received by a backend service. Thus, it is possible that an unhealthy endpoint is detected and ejected by only some of the proxies, and while this happens, other proxies may continue to send requests to the same unhealthy endpoint until they detect and eject the unhealthy endpoint. Applicable backend endpoints can be: - VM instances in an Instance Group - Endpoints in a Zonal NEG (GCE_VM_IP, GCE_VM_IP_PORT) - Endpoints in a Hybrid Connectivity NEG (NON_GCP_PRIVATE_IP_PORT) - Serverless NEGs, that resolve to Cloud Run, App Engine, or Cloud Functions Services - Private Service Connect NEGs, that resolve to Google-managed regional API endpoints or managed services published using Private Service Connect Applicable backend service types can be: - A global backend service with the loadBalancingScheme set to INTERNAL_SELF_MANAGED or EXTERNAL_MANAGED. - A regional backend service with the serviceProtocol set to HTTP, HTTPS, or HTTP2, and loadBalancingScheme set to INTERNAL_MANAGED or EXTERNAL_MANAGED. Not supported for Serverless NEGs. 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 .google.cloud.compute.v1.OutlierDetection outlier_detection = 354625086;- Specified by:
getOutlierDetectionin interfaceBackendServiceOrBuilder- Returns:
- The outlierDetection.
-
getOutlierDetectionOrBuilder
public OutlierDetectionOrBuilder getOutlierDetectionOrBuilder()
Settings controlling the ejection of unhealthy backend endpoints from the load balancing pool of each individual proxy instance that processes the traffic for the given backend service. If not set, this feature is considered disabled. Results of the outlier detection algorithm (ejection of endpoints from the load balancing pool and returning them back to the pool) are executed independently by each proxy instance of the load balancer. In most cases, more than one proxy instance handles the traffic received by a backend service. Thus, it is possible that an unhealthy endpoint is detected and ejected by only some of the proxies, and while this happens, other proxies may continue to send requests to the same unhealthy endpoint until they detect and eject the unhealthy endpoint. Applicable backend endpoints can be: - VM instances in an Instance Group - Endpoints in a Zonal NEG (GCE_VM_IP, GCE_VM_IP_PORT) - Endpoints in a Hybrid Connectivity NEG (NON_GCP_PRIVATE_IP_PORT) - Serverless NEGs, that resolve to Cloud Run, App Engine, or Cloud Functions Services - Private Service Connect NEGs, that resolve to Google-managed regional API endpoints or managed services published using Private Service Connect Applicable backend service types can be: - A global backend service with the loadBalancingScheme set to INTERNAL_SELF_MANAGED or EXTERNAL_MANAGED. - A regional backend service with the serviceProtocol set to HTTP, HTTPS, or HTTP2, and loadBalancingScheme set to INTERNAL_MANAGED or EXTERNAL_MANAGED. Not supported for Serverless NEGs. 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 .google.cloud.compute.v1.OutlierDetection outlier_detection = 354625086;- Specified by:
getOutlierDetectionOrBuilderin interfaceBackendServiceOrBuilder
-
hasPort
public 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;- Specified by:
hasPortin interfaceBackendServiceOrBuilder- Returns:
- Whether the port field is set.
-
getPort
public 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;- Specified by:
getPortin interfaceBackendServiceOrBuilder- Returns:
- The port.
-
hasPortName
public 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;- Specified by:
hasPortNamein interfaceBackendServiceOrBuilder- Returns:
- Whether the portName field is set.
-
getPortName
public 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;- Specified by:
getPortNamein interfaceBackendServiceOrBuilder- Returns:
- The portName.
-
getPortNameBytes
public 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;- Specified by:
getPortNameBytesin interfaceBackendServiceOrBuilder- Returns:
- The bytes for portName.
-
hasProtocol
public 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;- Specified by:
hasProtocolin interfaceBackendServiceOrBuilder- Returns:
- Whether the protocol field is set.
-
getProtocol
public 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;- Specified by:
getProtocolin interfaceBackendServiceOrBuilder- Returns:
- The protocol.
-
getProtocolBytes
public 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;- Specified by:
getProtocolBytesin interfaceBackendServiceOrBuilder- Returns:
- The bytes for protocol.
-
hasRegion
public 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;- Specified by:
hasRegionin interfaceBackendServiceOrBuilder- Returns:
- Whether the region field is set.
-
getRegion
public 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;- Specified by:
getRegionin interfaceBackendServiceOrBuilder- Returns:
- The region.
-
getRegionBytes
public 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;- Specified by:
getRegionBytesin interfaceBackendServiceOrBuilder- Returns:
- The bytes for region.
-
hasSecurityPolicy
public boolean hasSecurityPolicy()
[Output Only] The resource URL for the security policy associated with this backend service.
optional string security_policy = 171082513;- Specified by:
hasSecurityPolicyin interfaceBackendServiceOrBuilder- Returns:
- Whether the securityPolicy field is set.
-
getSecurityPolicy
public String getSecurityPolicy()
[Output Only] The resource URL for the security policy associated with this backend service.
optional string security_policy = 171082513;- Specified by:
getSecurityPolicyin interfaceBackendServiceOrBuilder- Returns:
- The securityPolicy.
-
getSecurityPolicyBytes
public com.google.protobuf.ByteString getSecurityPolicyBytes()
[Output Only] The resource URL for the security policy associated with this backend service.
optional string security_policy = 171082513;- Specified by:
getSecurityPolicyBytesin interfaceBackendServiceOrBuilder- Returns:
- The bytes for securityPolicy.
-
hasSecuritySettings
public 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;- Specified by:
hasSecuritySettingsin interfaceBackendServiceOrBuilder- Returns:
- Whether the securitySettings field is set.
-
getSecuritySettings
public 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;- Specified by:
getSecuritySettingsin interfaceBackendServiceOrBuilder- Returns:
- The securitySettings.
-
getSecuritySettingsOrBuilder
public 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;- Specified by:
getSecuritySettingsOrBuilderin interfaceBackendServiceOrBuilder
-
hasSelfLink
public boolean hasSelfLink()
[Output Only] Server-defined URL for the resource.
optional string self_link = 456214797;- Specified by:
hasSelfLinkin interfaceBackendServiceOrBuilder- Returns:
- Whether the selfLink field is set.
-
getSelfLink
public String getSelfLink()
[Output Only] Server-defined URL for the resource.
optional string self_link = 456214797;- Specified by:
getSelfLinkin interfaceBackendServiceOrBuilder- Returns:
- The selfLink.
-
getSelfLinkBytes
public com.google.protobuf.ByteString getSelfLinkBytes()
[Output Only] Server-defined URL for the resource.
optional string self_link = 456214797;- Specified by:
getSelfLinkBytesin interfaceBackendServiceOrBuilder- Returns:
- The bytes for selfLink.
-
getServiceBindingsList
public 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;- Specified by:
getServiceBindingsListin interfaceBackendServiceOrBuilder- Returns:
- A list containing the serviceBindings.
-
getServiceBindingsCount
public 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;- Specified by:
getServiceBindingsCountin interfaceBackendServiceOrBuilder- Returns:
- The count of serviceBindings.
-
getServiceBindings
public 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;- Specified by:
getServiceBindingsin interfaceBackendServiceOrBuilder- Parameters:
index- The index of the element to return.- Returns:
- The serviceBindings at the given index.
-
getServiceBindingsBytes
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;- Specified by:
getServiceBindingsBytesin interfaceBackendServiceOrBuilder- Parameters:
index- The index of the value to return.- Returns:
- The bytes of the serviceBindings at the given index.
-
hasSessionAffinity
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;- Specified by:
hasSessionAffinityin interfaceBackendServiceOrBuilder- Returns:
- Whether the sessionAffinity field is set.
-
getSessionAffinity
public 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;- Specified by:
getSessionAffinityin interfaceBackendServiceOrBuilder- Returns:
- The sessionAffinity.
-
getSessionAffinityBytes
public 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;- Specified by:
getSessionAffinityBytesin interfaceBackendServiceOrBuilder- Returns:
- The bytes for sessionAffinity.
-
hasSubsetting
public boolean hasSubsetting()
optional .google.cloud.compute.v1.Subsetting subsetting = 450283536;- Specified by:
hasSubsettingin interfaceBackendServiceOrBuilder- Returns:
- Whether the subsetting field is set.
-
getSubsetting
public Subsetting getSubsetting()
optional .google.cloud.compute.v1.Subsetting subsetting = 450283536;- Specified by:
getSubsettingin interfaceBackendServiceOrBuilder- Returns:
- The subsetting.
-
getSubsettingOrBuilder
public SubsettingOrBuilder getSubsettingOrBuilder()
optional .google.cloud.compute.v1.Subsetting subsetting = 450283536;- Specified by:
getSubsettingOrBuilderin interfaceBackendServiceOrBuilder
-
hasTimeoutSec
public 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;- Specified by:
hasTimeoutSecin interfaceBackendServiceOrBuilder- Returns:
- Whether the timeoutSec field is set.
-
getTimeoutSec
public 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;- Specified by:
getTimeoutSecin interfaceBackendServiceOrBuilder- Returns:
- The timeoutSec.
-
isInitialized
public final boolean isInitialized()
- Specified by:
isInitializedin interfacecom.google.protobuf.MessageLiteOrBuilder- Overrides:
isInitializedin classcom.google.protobuf.GeneratedMessageV3
-
writeTo
public void writeTo(com.google.protobuf.CodedOutputStream output) throws IOException- Specified by:
writeToin interfacecom.google.protobuf.MessageLite- Overrides:
writeToin classcom.google.protobuf.GeneratedMessageV3- Throws:
IOException
-
getSerializedSize
public int getSerializedSize()
- Specified by:
getSerializedSizein interfacecom.google.protobuf.MessageLite- Overrides:
getSerializedSizein classcom.google.protobuf.GeneratedMessageV3
-
equals
public boolean equals(Object obj)
- Specified by:
equalsin interfacecom.google.protobuf.Message- Overrides:
equalsin classcom.google.protobuf.AbstractMessage
-
hashCode
public int hashCode()
- Specified by:
hashCodein interfacecom.google.protobuf.Message- Overrides:
hashCodein classcom.google.protobuf.AbstractMessage
-
parseFrom
public static BackendService parseFrom(ByteBuffer data) throws com.google.protobuf.InvalidProtocolBufferException
- Throws:
com.google.protobuf.InvalidProtocolBufferException
-
parseFrom
public static BackendService parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
- Throws:
com.google.protobuf.InvalidProtocolBufferException
-
parseFrom
public static BackendService parseFrom(com.google.protobuf.ByteString data) throws com.google.protobuf.InvalidProtocolBufferException
- Throws:
com.google.protobuf.InvalidProtocolBufferException
-
parseFrom
public static BackendService parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
- Throws:
com.google.protobuf.InvalidProtocolBufferException
-
parseFrom
public static BackendService parseFrom(byte[] data) throws com.google.protobuf.InvalidProtocolBufferException
- Throws:
com.google.protobuf.InvalidProtocolBufferException
-
parseFrom
public static BackendService parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
- Throws:
com.google.protobuf.InvalidProtocolBufferException
-
parseFrom
public static BackendService parseFrom(InputStream input) throws IOException
- Throws:
IOException
-
parseFrom
public static BackendService parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
- Throws:
IOException
-
parseDelimitedFrom
public static BackendService parseDelimitedFrom(InputStream input) throws IOException
- Throws:
IOException
-
parseDelimitedFrom
public static BackendService parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
- Throws:
IOException
-
parseFrom
public static BackendService parseFrom(com.google.protobuf.CodedInputStream input) throws IOException
- Throws:
IOException
-
parseFrom
public static BackendService parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
- Throws:
IOException
-
newBuilderForType
public BackendService.Builder newBuilderForType()
- Specified by:
newBuilderForTypein interfacecom.google.protobuf.Message- Specified by:
newBuilderForTypein interfacecom.google.protobuf.MessageLite
-
newBuilder
public static BackendService.Builder newBuilder()
-
newBuilder
public static BackendService.Builder newBuilder(BackendService prototype)
-
toBuilder
public BackendService.Builder toBuilder()
- Specified by:
toBuilderin interfacecom.google.protobuf.Message- Specified by:
toBuilderin interfacecom.google.protobuf.MessageLite
-
newBuilderForType
protected BackendService.Builder newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
- Specified by:
newBuilderForTypein classcom.google.protobuf.GeneratedMessageV3
-
getDefaultInstance
public static BackendService getDefaultInstance()
-
parser
public static com.google.protobuf.Parser<BackendService> parser()
-
getParserForType
public com.google.protobuf.Parser<BackendService> getParserForType()
- Specified by:
getParserForTypein interfacecom.google.protobuf.Message- Specified by:
getParserForTypein interfacecom.google.protobuf.MessageLite- Overrides:
getParserForTypein classcom.google.protobuf.GeneratedMessageV3
-
getDefaultInstanceForType
public BackendService getDefaultInstanceForType()
- Specified by:
getDefaultInstanceForTypein interfacecom.google.protobuf.MessageLiteOrBuilder- Specified by:
getDefaultInstanceForTypein interfacecom.google.protobuf.MessageOrBuilder
-
-