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 class
BackendService.Builder
Represents a Backend Service resource.static class
BackendService.CompressionMode
Compress text responses using Brotli or gzip compression, based on the client's Accept-Encoding header.static class
BackendService.LoadBalancingScheme
Specifies the load balancer type.static class
BackendService.LocalityLbPolicy
The load balancing algorithm used within the scope of the locality.static class
BackendService.Protocol
The protocol this BackendService uses to communicate with backends.static class
BackendService.SessionAffinity
Type of session affinity to use.-
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 boolean
containsMetadatas(String key)
Deployment metadata associated with the resource to be set by a GKE hub controller and read by the backend RCTHboolean
equals(Object obj)
int
getAffinityCookieTtlSec()
Lifetime of cookies in seconds.Backend
getBackends(int index)
The list of backends that serve this BackendService.int
getBackendsCount()
The list of backends that serve this BackendService.List<Backend>
getBackendsList()
The list of backends that serve this BackendService.BackendOrBuilder
getBackendsOrBuilder(int index)
The list of backends that serve this BackendService.List<? extends BackendOrBuilder>
getBackendsOrBuilderList()
The list of backends that serve this BackendService.BackendServiceCdnPolicy
getCdnPolicy()
Cloud CDN configuration for this BackendService.BackendServiceCdnPolicyOrBuilder
getCdnPolicyOrBuilder()
Cloud CDN configuration for this BackendService.CircuitBreakers
getCircuitBreakers()
optional .google.cloud.compute.v1.CircuitBreakers circuit_breakers = 421340061;
CircuitBreakersOrBuilder
getCircuitBreakersOrBuilder()
optional .google.cloud.compute.v1.CircuitBreakers circuit_breakers = 421340061;
String
getCompressionMode()
Compress text responses using Brotli or gzip compression, based on the client's Accept-Encoding header.com.google.protobuf.ByteString
getCompressionModeBytes()
Compress text responses using Brotli or gzip compression, based on the client's Accept-Encoding header.ConnectionDraining
getConnectionDraining()
optional .google.cloud.compute.v1.ConnectionDraining connection_draining = 461096747;
ConnectionDrainingOrBuilder
getConnectionDrainingOrBuilder()
optional .google.cloud.compute.v1.ConnectionDraining connection_draining = 461096747;
BackendServiceConnectionTrackingPolicy
getConnectionTrackingPolicy()
Connection Tracking configuration for this BackendService.BackendServiceConnectionTrackingPolicyOrBuilder
getConnectionTrackingPolicyOrBuilder()
Connection Tracking configuration for this BackendService.ConsistentHashLoadBalancerSettings
getConsistentHash()
Consistent Hash-based load balancing can be used to provide soft session affinity based on HTTP headers, cookies or other properties.ConsistentHashLoadBalancerSettingsOrBuilder
getConsistentHashOrBuilder()
Consistent Hash-based load balancing can be used to provide soft session affinity based on HTTP headers, cookies or other properties.String
getCreationTimestamp()
[Output Only] Creation timestamp in RFC3339 text format.com.google.protobuf.ByteString
getCreationTimestampBytes()
[Output Only] Creation timestamp in RFC3339 text format.String
getCustomRequestHeaders(int index)
Headers that the load balancer adds to proxied requests.com.google.protobuf.ByteString
getCustomRequestHeadersBytes(int index)
Headers that the load balancer adds to proxied requests.int
getCustomRequestHeadersCount()
Headers that the load balancer adds to proxied requests.com.google.protobuf.ProtocolStringList
getCustomRequestHeadersList()
Headers that the load balancer adds to proxied requests.String
getCustomResponseHeaders(int index)
Headers that the load balancer adds to proxied responses.com.google.protobuf.ByteString
getCustomResponseHeadersBytes(int index)
Headers that the load balancer adds to proxied responses.int
getCustomResponseHeadersCount()
Headers that the load balancer adds to proxied responses.com.google.protobuf.ProtocolStringList
getCustomResponseHeadersList()
Headers that the load balancer adds to proxied responses.static BackendService
getDefaultInstance()
BackendService
getDefaultInstanceForType()
String
getDescription()
An optional description of this resource.com.google.protobuf.ByteString
getDescriptionBytes()
An optional description of this resource.static com.google.protobuf.Descriptors.Descriptor
getDescriptor()
String
getEdgeSecurityPolicy()
[Output Only] The resource URL for the edge security policy associated with this backend service.com.google.protobuf.ByteString
getEdgeSecurityPolicyBytes()
[Output Only] The resource URL for the edge security policy associated with this backend service.boolean
getEnableCDN()
If true, enables Cloud CDN for the backend service of an external HTTP(S) load balancer.BackendServiceFailoverPolicy
getFailoverPolicy()
Requires at least one backend instance group to be defined as a backup (failover) backend.BackendServiceFailoverPolicyOrBuilder
getFailoverPolicyOrBuilder()
Requires at least one backend instance group to be defined as a backup (failover) backend.String
getFingerprint()
Fingerprint of this resource.com.google.protobuf.ByteString
getFingerprintBytes()
Fingerprint of this resource.String
getHealthChecks(int index)
The list of URLs to the healthChecks, httpHealthChecks (legacy), or httpsHealthChecks (legacy) resource for health checking this backend service.com.google.protobuf.ByteString
getHealthChecksBytes(int index)
The list of URLs to the healthChecks, httpHealthChecks (legacy), or httpsHealthChecks (legacy) resource for health checking this backend service.int
getHealthChecksCount()
The list of URLs to the healthChecks, httpHealthChecks (legacy), or httpsHealthChecks (legacy) resource for health checking this backend service.com.google.protobuf.ProtocolStringList
getHealthChecksList()
The list of URLs to the healthChecks, httpHealthChecks (legacy), or httpsHealthChecks (legacy) resource for health checking this backend service.BackendServiceIAP
getIap()
The configurations for Identity-Aware Proxy on this resource.BackendServiceIAPOrBuilder
getIapOrBuilder()
The configurations for Identity-Aware Proxy on this resource.long
getId()
[Output Only] The unique identifier for the resource.String
getKind()
[Output Only] Type of resource.com.google.protobuf.ByteString
getKindBytes()
[Output Only] Type of resource.String
getLoadBalancingScheme()
Specifies the load balancer type.com.google.protobuf.ByteString
getLoadBalancingSchemeBytes()
Specifies the load balancer type.BackendServiceLocalityLoadBalancingPolicyConfig
getLocalityLbPolicies(int index)
A list of locality load-balancing policies to be used in order of preference.int
getLocalityLbPoliciesCount()
A list of locality load-balancing policies to be used in order of preference.List<BackendServiceLocalityLoadBalancingPolicyConfig>
getLocalityLbPoliciesList()
A list of locality load-balancing policies to be used in order of preference.BackendServiceLocalityLoadBalancingPolicyConfigOrBuilder
getLocalityLbPoliciesOrBuilder(int index)
A list of locality load-balancing policies to be used in order of preference.List<? extends BackendServiceLocalityLoadBalancingPolicyConfigOrBuilder>
getLocalityLbPoliciesOrBuilderList()
A list of locality load-balancing policies to be used in order of preference.String
getLocalityLbPolicy()
The load balancing algorithm used within the scope of the locality.com.google.protobuf.ByteString
getLocalityLbPolicyBytes()
The load balancing algorithm used within the scope of the locality.BackendServiceLogConfig
getLogConfig()
This field denotes the logging options for the load balancer traffic served by this backend service.BackendServiceLogConfigOrBuilder
getLogConfigOrBuilder()
This field denotes the logging options for the load balancer traffic served by this backend service.Duration
getMaxStreamDuration()
Specifies the default maximum duration (timeout) for streams to this service.DurationOrBuilder
getMaxStreamDurationOrBuilder()
Specifies the default maximum duration (timeout) for streams to this service.Map<String,String>
getMetadatas()
Deprecated.int
getMetadatasCount()
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 RCTHString
getMetadatasOrDefault(String key, String defaultValue)
Deployment metadata associated with the resource to be set by a GKE hub controller and read by the backend RCTHString
getMetadatasOrThrow(String key)
Deployment metadata associated with the resource to be set by a GKE hub controller and read by the backend RCTHString
getName()
Name of the resource.com.google.protobuf.ByteString
getNameBytes()
Name of the resource.String
getNetwork()
The URL of the network to which this backend service belongs.com.google.protobuf.ByteString
getNetworkBytes()
The URL of the network to which this backend service belongs.OutlierDetection
getOutlierDetection()
Settings controlling the ejection of unhealthy backend endpoints from the load balancing pool of each individual proxy instance that processes the traffic for the given backend service.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.com.google.protobuf.Parser<BackendService>
getParserForType()
int
getPort()
Deprecated in favor of portName.String
getPortName()
A named port on a backend instance group representing the port for communication to the backend VMs in that group.com.google.protobuf.ByteString
getPortNameBytes()
A named port on a backend instance group representing the port for communication to the backend VMs in that group.String
getProtocol()
The protocol this BackendService uses to communicate with backends.com.google.protobuf.ByteString
getProtocolBytes()
The protocol this BackendService uses to communicate with backends.String
getRegion()
[Output Only] URL of the region where the regional backend service resides.com.google.protobuf.ByteString
getRegionBytes()
[Output Only] URL of the region where the regional backend service resides.String
getSecurityPolicy()
[Output Only] The resource URL for the security policy associated with this backend service.com.google.protobuf.ByteString
getSecurityPolicyBytes()
[Output Only] The resource URL for the security policy associated with this backend service.SecuritySettings
getSecuritySettings()
This field specifies the security settings that apply to this backend service.SecuritySettingsOrBuilder
getSecuritySettingsOrBuilder()
This field specifies the security settings that apply to this backend service.String
getSelfLink()
[Output Only] Server-defined URL for the resource.com.google.protobuf.ByteString
getSelfLinkBytes()
[Output Only] Server-defined URL for the resource.int
getSerializedSize()
String
getServiceBindings(int index)
URLs of networkservices.ServiceBinding resources.com.google.protobuf.ByteString
getServiceBindingsBytes(int index)
URLs of networkservices.ServiceBinding resources.int
getServiceBindingsCount()
URLs of networkservices.ServiceBinding resources.com.google.protobuf.ProtocolStringList
getServiceBindingsList()
URLs of networkservices.ServiceBinding resources.String
getSessionAffinity()
Type of session affinity to use.com.google.protobuf.ByteString
getSessionAffinityBytes()
Type of session affinity to use.Subsetting
getSubsetting()
optional .google.cloud.compute.v1.Subsetting subsetting = 450283536;
SubsettingOrBuilder
getSubsettingOrBuilder()
optional .google.cloud.compute.v1.Subsetting subsetting = 450283536;
int
getTimeoutSec()
The backend service timeout has a different meaning depending on the type of load balancer.boolean
hasAffinityCookieTtlSec()
Lifetime of cookies in seconds.boolean
hasCdnPolicy()
Cloud CDN configuration for this BackendService.boolean
hasCircuitBreakers()
optional .google.cloud.compute.v1.CircuitBreakers circuit_breakers = 421340061;
boolean
hasCompressionMode()
Compress text responses using Brotli or gzip compression, based on the client's Accept-Encoding header.boolean
hasConnectionDraining()
optional .google.cloud.compute.v1.ConnectionDraining connection_draining = 461096747;
boolean
hasConnectionTrackingPolicy()
Connection Tracking configuration for this BackendService.boolean
hasConsistentHash()
Consistent Hash-based load balancing can be used to provide soft session affinity based on HTTP headers, cookies or other properties.boolean
hasCreationTimestamp()
[Output Only] Creation timestamp in RFC3339 text format.boolean
hasDescription()
An optional description of this resource.boolean
hasEdgeSecurityPolicy()
[Output Only] The resource URL for the edge security policy associated with this backend service.boolean
hasEnableCDN()
If true, enables Cloud CDN for the backend service of an external HTTP(S) load balancer.boolean
hasFailoverPolicy()
Requires at least one backend instance group to be defined as a backup (failover) backend.boolean
hasFingerprint()
Fingerprint of this resource.int
hashCode()
boolean
hasIap()
The configurations for Identity-Aware Proxy on this resource.boolean
hasId()
[Output Only] The unique identifier for the resource.boolean
hasKind()
[Output Only] Type of resource.boolean
hasLoadBalancingScheme()
Specifies the load balancer type.boolean
hasLocalityLbPolicy()
The load balancing algorithm used within the scope of the locality.boolean
hasLogConfig()
This field denotes the logging options for the load balancer traffic served by this backend service.boolean
hasMaxStreamDuration()
Specifies the default maximum duration (timeout) for streams to this service.boolean
hasName()
Name of the resource.boolean
hasNetwork()
The URL of the network to which this backend service belongs.boolean
hasOutlierDetection()
Settings controlling the ejection of unhealthy backend endpoints from the load balancing pool of each individual proxy instance that processes the traffic for the given backend service.boolean
hasPort()
Deprecated in favor of portName.boolean
hasPortName()
A named port on a backend instance group representing the port for communication to the backend VMs in that group.boolean
hasProtocol()
The protocol this BackendService uses to communicate with backends.boolean
hasRegion()
[Output Only] URL of the region where the regional backend service resides.boolean
hasSecurityPolicy()
[Output Only] The resource URL for the security policy associated with this backend service.boolean
hasSecuritySettings()
This field specifies the security settings that apply to this backend service.boolean
hasSelfLink()
[Output Only] Server-defined URL for the resource.boolean
hasSessionAffinity()
Type of session affinity to use.boolean
hasSubsetting()
optional .google.cloud.compute.v1.Subsetting subsetting = 450283536;
boolean
hasTimeoutSec()
The backend service timeout has a different meaning depending on the type of load balancer.protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable
internalGetFieldAccessorTable()
protected com.google.protobuf.MapField
internalGetMapField(int number)
boolean
isInitialized()
static BackendService.Builder
newBuilder()
static BackendService.Builder
newBuilder(BackendService prototype)
BackendService.Builder
newBuilderForType()
protected BackendService.Builder
newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
protected Object
newInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)
static BackendService
parseDelimitedFrom(InputStream input)
static BackendService
parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static BackendService
parseFrom(byte[] data)
static BackendService
parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static BackendService
parseFrom(com.google.protobuf.ByteString data)
static BackendService
parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static BackendService
parseFrom(com.google.protobuf.CodedInputStream input)
static BackendService
parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static BackendService
parseFrom(InputStream input)
static BackendService
parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static BackendService
parseFrom(ByteBuffer data)
static BackendService
parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static com.google.protobuf.Parser<BackendService>
parser()
BackendService.Builder
toBuilder()
void
writeTo(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:
newInstance
in classcom.google.protobuf.GeneratedMessageV3
-
getDescriptor
public static final com.google.protobuf.Descriptors.Descriptor getDescriptor()
-
internalGetMapField
protected com.google.protobuf.MapField internalGetMapField(int number)
- Overrides:
internalGetMapField
in classcom.google.protobuf.GeneratedMessageV3
-
internalGetFieldAccessorTable
protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
- Specified by:
internalGetFieldAccessorTable
in 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:
hasAffinityCookieTtlSec
in 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:
getAffinityCookieTtlSec
in 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:
getBackendsList
in 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:
getBackendsOrBuilderList
in interfaceBackendServiceOrBuilder
-
getBackendsCount
public int getBackendsCount()
The list of backends that serve this BackendService.
repeated .google.cloud.compute.v1.Backend backends = 510839903;
- Specified by:
getBackendsCount
in 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:
getBackends
in 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:
getBackendsOrBuilder
in 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:
hasCdnPolicy
in 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:
getCdnPolicy
in 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:
getCdnPolicyOrBuilder
in interfaceBackendServiceOrBuilder
-
hasCircuitBreakers
public boolean hasCircuitBreakers()
optional .google.cloud.compute.v1.CircuitBreakers circuit_breakers = 421340061;
- Specified by:
hasCircuitBreakers
in interfaceBackendServiceOrBuilder
- Returns:
- Whether the circuitBreakers field is set.
-
getCircuitBreakers
public CircuitBreakers getCircuitBreakers()
optional .google.cloud.compute.v1.CircuitBreakers circuit_breakers = 421340061;
- Specified by:
getCircuitBreakers
in interfaceBackendServiceOrBuilder
- Returns:
- The circuitBreakers.
-
getCircuitBreakersOrBuilder
public CircuitBreakersOrBuilder getCircuitBreakersOrBuilder()
optional .google.cloud.compute.v1.CircuitBreakers circuit_breakers = 421340061;
- Specified by:
getCircuitBreakersOrBuilder
in 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:
hasCompressionMode
in 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:
getCompressionMode
in 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:
getCompressionModeBytes
in interfaceBackendServiceOrBuilder
- Returns:
- The bytes for compressionMode.
-
hasConnectionDraining
public boolean hasConnectionDraining()
optional .google.cloud.compute.v1.ConnectionDraining connection_draining = 461096747;
- Specified by:
hasConnectionDraining
in interfaceBackendServiceOrBuilder
- Returns:
- Whether the connectionDraining field is set.
-
getConnectionDraining
public ConnectionDraining getConnectionDraining()
optional .google.cloud.compute.v1.ConnectionDraining connection_draining = 461096747;
- Specified by:
getConnectionDraining
in interfaceBackendServiceOrBuilder
- Returns:
- The connectionDraining.
-
getConnectionDrainingOrBuilder
public ConnectionDrainingOrBuilder getConnectionDrainingOrBuilder()
optional .google.cloud.compute.v1.ConnectionDraining connection_draining = 461096747;
- Specified by:
getConnectionDrainingOrBuilder
in 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:
hasConnectionTrackingPolicy
in 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:
getConnectionTrackingPolicy
in 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:
getConnectionTrackingPolicyOrBuilder
in 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:
hasConsistentHash
in 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:
getConsistentHash
in 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:
getConsistentHashOrBuilder
in interfaceBackendServiceOrBuilder
-
hasCreationTimestamp
public boolean hasCreationTimestamp()
[Output Only] Creation timestamp in RFC3339 text format.
optional string creation_timestamp = 30525366;
- Specified by:
hasCreationTimestamp
in 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:
getCreationTimestamp
in 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:
getCreationTimestampBytes
in 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:
getCustomRequestHeadersList
in 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:
getCustomRequestHeadersCount
in 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:
getCustomRequestHeaders
in 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:
getCustomRequestHeadersBytes
in 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:
getCustomResponseHeadersList
in 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:
getCustomResponseHeadersCount
in 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:
getCustomResponseHeaders
in 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:
getCustomResponseHeadersBytes
in 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:
hasDescription
in 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:
getDescription
in 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:
getDescriptionBytes
in 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:
hasEdgeSecurityPolicy
in 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:
getEdgeSecurityPolicy
in 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:
getEdgeSecurityPolicyBytes
in 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:
hasEnableCDN
in 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:
getEnableCDN
in 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:
hasFailoverPolicy
in 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:
getFailoverPolicy
in 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:
getFailoverPolicyOrBuilder
in 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:
hasFingerprint
in 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:
getFingerprint
in 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:
getFingerprintBytes
in 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:
getHealthChecksList
in 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:
getHealthChecksCount
in 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:
getHealthChecks
in 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:
getHealthChecksBytes
in 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:
hasIap
in 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:
getIap
in 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:
getIapOrBuilder
in 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:
hasId
in 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:
getId
in 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:
hasKind
in 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:
getKind
in 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:
getKindBytes
in 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:
hasLoadBalancingScheme
in 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:
getLoadBalancingScheme
in 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:
getLoadBalancingSchemeBytes
in 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:
getLocalityLbPoliciesList
in 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:
getLocalityLbPoliciesOrBuilderList
in 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:
getLocalityLbPoliciesCount
in 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:
getLocalityLbPolicies
in 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:
getLocalityLbPoliciesOrBuilder
in 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:
hasLocalityLbPolicy
in 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:
getLocalityLbPolicy
in 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:
getLocalityLbPolicyBytes
in 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:
hasLogConfig
in 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:
getLogConfig
in 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:
getLogConfigOrBuilder
in 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:
hasMaxStreamDuration
in 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:
getMaxStreamDuration
in 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:
getMaxStreamDurationOrBuilder
in interfaceBackendServiceOrBuilder
-
getMetadatasCount
public int getMetadatasCount()
Description copied from interface:BackendServiceOrBuilder
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:
getMetadatasCount
in 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:
containsMetadatas
in interfaceBackendServiceOrBuilder
-
getMetadatas
@Deprecated public Map<String,String> getMetadatas()
Deprecated.UsegetMetadatasMap()
instead.- Specified by:
getMetadatas
in 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:
getMetadatasMap
in 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:
getMetadatasOrDefault
in 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:
getMetadatasOrThrow
in 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:
hasName
in 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:
getName
in 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:
getNameBytes
in 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:
hasNetwork
in 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:
getNetwork
in 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:
getNetworkBytes
in 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:
hasOutlierDetection
in 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:
getOutlierDetection
in 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:
getOutlierDetectionOrBuilder
in 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:
hasPort
in 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:
getPort
in 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:
hasPortName
in 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:
getPortName
in 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:
getPortNameBytes
in 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:
hasProtocol
in 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:
getProtocol
in 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:
getProtocolBytes
in 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:
hasRegion
in 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:
getRegion
in 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:
getRegionBytes
in 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:
hasSecurityPolicy
in 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:
getSecurityPolicy
in 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:
getSecurityPolicyBytes
in 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:
hasSecuritySettings
in 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:
getSecuritySettings
in 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:
getSecuritySettingsOrBuilder
in interfaceBackendServiceOrBuilder
-
hasSelfLink
public boolean hasSelfLink()
[Output Only] Server-defined URL for the resource.
optional string self_link = 456214797;
- Specified by:
hasSelfLink
in 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:
getSelfLink
in 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:
getSelfLinkBytes
in 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:
getServiceBindingsList
in 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:
getServiceBindingsCount
in 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:
getServiceBindings
in 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:
getServiceBindingsBytes
in 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:
hasSessionAffinity
in 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:
getSessionAffinity
in 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:
getSessionAffinityBytes
in interfaceBackendServiceOrBuilder
- Returns:
- The bytes for sessionAffinity.
-
hasSubsetting
public boolean hasSubsetting()
optional .google.cloud.compute.v1.Subsetting subsetting = 450283536;
- Specified by:
hasSubsetting
in interfaceBackendServiceOrBuilder
- Returns:
- Whether the subsetting field is set.
-
getSubsetting
public Subsetting getSubsetting()
optional .google.cloud.compute.v1.Subsetting subsetting = 450283536;
- Specified by:
getSubsetting
in interfaceBackendServiceOrBuilder
- Returns:
- The subsetting.
-
getSubsettingOrBuilder
public SubsettingOrBuilder getSubsettingOrBuilder()
optional .google.cloud.compute.v1.Subsetting subsetting = 450283536;
- Specified by:
getSubsettingOrBuilder
in 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:
hasTimeoutSec
in 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:
getTimeoutSec
in interfaceBackendServiceOrBuilder
- Returns:
- The timeoutSec.
-
isInitialized
public final boolean isInitialized()
- Specified by:
isInitialized
in interfacecom.google.protobuf.MessageLiteOrBuilder
- Overrides:
isInitialized
in classcom.google.protobuf.GeneratedMessageV3
-
writeTo
public void writeTo(com.google.protobuf.CodedOutputStream output) throws IOException
- Specified by:
writeTo
in interfacecom.google.protobuf.MessageLite
- Overrides:
writeTo
in classcom.google.protobuf.GeneratedMessageV3
- Throws:
IOException
-
getSerializedSize
public int getSerializedSize()
- Specified by:
getSerializedSize
in interfacecom.google.protobuf.MessageLite
- Overrides:
getSerializedSize
in classcom.google.protobuf.GeneratedMessageV3
-
equals
public boolean equals(Object obj)
- Specified by:
equals
in interfacecom.google.protobuf.Message
- Overrides:
equals
in classcom.google.protobuf.AbstractMessage
-
hashCode
public int hashCode()
- Specified by:
hashCode
in interfacecom.google.protobuf.Message
- Overrides:
hashCode
in 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:
newBuilderForType
in interfacecom.google.protobuf.Message
- Specified by:
newBuilderForType
in 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:
toBuilder
in interfacecom.google.protobuf.Message
- Specified by:
toBuilder
in interfacecom.google.protobuf.MessageLite
-
newBuilderForType
protected BackendService.Builder newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
- Specified by:
newBuilderForType
in 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:
getParserForType
in interfacecom.google.protobuf.Message
- Specified by:
getParserForType
in interfacecom.google.protobuf.MessageLite
- Overrides:
getParserForType
in classcom.google.protobuf.GeneratedMessageV3
-
getDefaultInstanceForType
public BackendService getDefaultInstanceForType()
- Specified by:
getDefaultInstanceForType
in interfacecom.google.protobuf.MessageLiteOrBuilder
- Specified by:
getDefaultInstanceForType
in interfacecom.google.protobuf.MessageOrBuilder
-
-