Package com.google.cloud.compute.v1
Class BackendService
java.lang.Object
com.google.protobuf.AbstractMessageLite
com.google.protobuf.AbstractMessage
com.google.protobuf.GeneratedMessage
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
@Generated
public final class BackendService
extends com.google.protobuf.GeneratedMessage
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, seeBackend Services.Protobuf type
google.cloud.compute.v1.BackendService- See Also:
-
Nested Class Summary
Nested ClassesModifier and TypeClassDescriptionstatic final classRepresents a Backend Service resource.static enumCompress text responses using Brotli or gzip compression, based on the client's Accept-Encoding header.static enumSpecifies the canary migration state.static enumSpecifies a preference for traffic sent from the proxy to the backend (or from the client to the backend for proxyless gRPC).static enumSpecifies the load balancer type.static enumThe load balancing algorithm used within the scope of the locality.static enumThe protocol this BackendService uses to communicate with backends.static enumType of session affinity to use.Nested classes/interfaces inherited from class com.google.protobuf.GeneratedMessage
com.google.protobuf.GeneratedMessage.ExtendableBuilder<MessageT extends com.google.protobuf.GeneratedMessage.ExtendableMessage<MessageT>,BuilderT extends com.google.protobuf.GeneratedMessage.ExtendableBuilder<MessageT, BuilderT>>, com.google.protobuf.GeneratedMessage.ExtendableMessage<MessageT extends com.google.protobuf.GeneratedMessage.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessage.ExtendableMessageOrBuilder<MessageT extends com.google.protobuf.GeneratedMessage.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessage.FieldAccessorTable, com.google.protobuf.GeneratedMessage.GeneratedExtension<ContainingT extends com.google.protobuf.Message, T extends Object>, com.google.protobuf.GeneratedMessage.UnusedPrivateParameter Nested classes/interfaces inherited from class com.google.protobuf.AbstractMessage
com.google.protobuf.AbstractMessage.BuilderParentNested classes/interfaces inherited from class com.google.protobuf.AbstractMessageLite
com.google.protobuf.AbstractMessageLite.InternalOneOfEnum -
Field Summary
FieldsModifier and TypeFieldDescriptionstatic final intstatic final intstatic final intstatic final intstatic final intstatic final intstatic final intstatic final intstatic final intstatic final intstatic final intstatic final intstatic final intstatic final intstatic final intstatic final intstatic final intstatic final intstatic final intstatic final intstatic final intstatic final intstatic final intstatic final intstatic final intstatic final intstatic final intstatic final intstatic final intstatic final intstatic final intstatic final intstatic final intstatic final intstatic final intstatic final intstatic final intstatic final intstatic final intstatic final intstatic final intstatic final intstatic final intstatic final intstatic final intstatic final intstatic final intstatic final intstatic final intstatic final intstatic final intstatic final intFields inherited from class com.google.protobuf.GeneratedMessage
alwaysUseFieldBuilders, loggedPre22TypeNames, unknownFieldsFields inherited from class com.google.protobuf.AbstractMessage
memoizedSizeFields inherited from class com.google.protobuf.AbstractMessageLite
memoizedHashCode -
Method Summary
Modifier and TypeMethodDescriptionbooleancontainsMetadatas(String key) Deployment metadata associated with the resource to be set by a GKE hub controller and read by the backend RCTHbooleanintLifetime of cookies in seconds.getBackends(int index) The list of backends that serve this BackendService.intThe list of backends that serve this BackendService.The list of backends that serve this BackendService.getBackendsOrBuilder(int index) The list of backends that serve this BackendService.List<? extends BackendOrBuilder>The list of backends that serve this BackendService.Cloud CDN configuration for this BackendService.Cloud CDN configuration for this BackendService.optional .google.cloud.compute.v1.CircuitBreakers circuit_breakers = 421340061;optional .google.cloud.compute.v1.CircuitBreakers circuit_breakers = 421340061;Compress text responses using Brotli or gzip compression, based on the client's Accept-Encoding header.com.google.protobuf.ByteStringCompress text responses using Brotli or gzip compression, based on the client's Accept-Encoding header.connectionDraining cannot be specified with haPolicy.connectionDraining cannot be specified with haPolicy.Connection Tracking configuration for this BackendService.Connection Tracking configuration for this BackendService.Consistent Hash-based load balancing can be used to provide soft session affinity based on HTTP headers, cookies or other properties.Consistent Hash-based load balancing can be used to provide soft session affinity based on HTTP headers, cookies or other properties.Output only.com.google.protobuf.ByteStringOutput only.getCustomMetrics(int index) List of custom metrics that are used for theWEIGHTED_ROUND_ROBIN locality_lb_policy.intList of custom metrics that are used for theWEIGHTED_ROUND_ROBIN locality_lb_policy.List of custom metrics that are used for theWEIGHTED_ROUND_ROBIN locality_lb_policy.getCustomMetricsOrBuilder(int index) List of custom metrics that are used for theWEIGHTED_ROUND_ROBIN locality_lb_policy.List<? extends BackendServiceCustomMetricOrBuilder>List of custom metrics that are used for theWEIGHTED_ROUND_ROBIN locality_lb_policy.getCustomRequestHeaders(int index) Headers that the load balancer adds to proxied requests.com.google.protobuf.ByteStringgetCustomRequestHeadersBytes(int index) Headers that the load balancer adds to proxied requests.intHeaders that the load balancer adds to proxied requests.com.google.protobuf.ProtocolStringListHeaders that the load balancer adds to proxied requests.getCustomResponseHeaders(int index) Headers that the load balancer adds to proxied responses.com.google.protobuf.ByteStringgetCustomResponseHeadersBytes(int index) Headers that the load balancer adds to proxied responses.intHeaders that the load balancer adds to proxied responses.com.google.protobuf.ProtocolStringListHeaders that the load balancer adds to proxied responses.static BackendServiceAn optional description of this resource.com.google.protobuf.ByteStringAn optional description of this resource.static final com.google.protobuf.Descriptors.Descriptor[Output Only] The resource URL for the edge security policy associated with this backend service.com.google.protobuf.ByteString[Output Only] The resource URL for the edge security policy associated with this backend service.booleanIf true, enables Cloud CDN for the backend service of a global external Application Load Balancer.Specifies the canary migration state.com.google.protobuf.ByteStringSpecifies the canary migration state.floatDetermines the fraction of requests that should be processed by the Global external Application Load Balancer.Requires at least one backend instance group to be defined as a backup (failover) backend.Requires at least one backend instance group to be defined as a backup (failover) backend.Fingerprint of this resource.com.google.protobuf.ByteStringFingerprint of this resource.Configures self-managed High Availability (HA) for External and Internal Protocol Forwarding.Configures self-managed High Availability (HA) for External and Internal Protocol Forwarding.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.ByteStringgetHealthChecksBytes(int index) The list of URLs to the healthChecks, httpHealthChecks (legacy), or httpsHealthChecks (legacy) resource for health checking this backend service.intThe list of URLs to the healthChecks, httpHealthChecks (legacy), or httpsHealthChecks (legacy) resource for health checking this backend service.com.google.protobuf.ProtocolStringListThe list of URLs to the healthChecks, httpHealthChecks (legacy), or httpsHealthChecks (legacy) resource for health checking this backend service.getIap()The configurations for Identity-Aware Proxy on this resource.The configurations for Identity-Aware Proxy on this resource.longgetId()[Output Only] The unique identifier for the resource.Specifies a preference for traffic sent from the proxy to the backend (or from the client to the backend for proxyless gRPC).com.google.protobuf.ByteStringSpecifies a preference for traffic sent from the proxy to the backend (or from the client to the backend for proxyless gRPC).getKind()Output only.com.google.protobuf.ByteStringOutput only.Specifies the load balancer type.com.google.protobuf.ByteStringSpecifies the load balancer type.getLocalityLbPolicies(int index) A list of locality load-balancing policies to be used in order of preference.intA list of locality load-balancing policies to be used in order of preference.A list of locality load-balancing policies to be used in order of preference.getLocalityLbPoliciesOrBuilder(int index) A list of locality load-balancing policies to be used in order of preference.A list of locality load-balancing policies to be used in order of preference.The load balancing algorithm used within the scope of the locality.com.google.protobuf.ByteStringThe load balancing algorithm used within the scope of the locality.This field denotes the logging options for the load balancer traffic served by this backend service.This field denotes the logging options for the load balancer traffic served by this backend service.Specifies the default maximum duration (timeout) for streams to this service.Specifies the default maximum duration (timeout) for streams to this service.Deprecated.intDeployment metadata associated with the resource to be set by a GKE hub controller and read by the backend RCTHDeployment metadata associated with the resource to be set by a GKE hub controller and read by the backend RCTHgetMetadatasOrDefault(String key, String defaultValue) Deployment metadata associated with the resource to be set by a GKE hub controller and read by the backend RCTHDeployment metadata associated with the resource to be set by a GKE hub controller and read by the backend RCTHgetName()Name of the resource.com.google.protobuf.ByteStringName of the resource.The URL of the network to which this backend service belongs.com.google.protobuf.ByteStringThe URL of the network to which this backend service belongs.Configures traffic steering properties of internal passthrough Network Load Balancers.Configures traffic steering properties of internal passthrough Network Load Balancers.Information about the resource or system that manages the backend service.Information about the resource or system that manages the backend service.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.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.Input only.Input only.com.google.protobuf.Parser<BackendService>intgetPort()Deprecated in favor of portName.A named port on a backend instance group representing the port for communication to the backend VMs in that group.com.google.protobuf.ByteStringA named port on a backend instance group representing the port for communication to the backend VMs in that group.The protocol this BackendService uses to communicate with backends.com.google.protobuf.ByteStringThe protocol this BackendService uses to communicate with backends.Output only.com.google.protobuf.ByteStringOutput only.[Output Only] The resource URL for the security policy associated with this backend service.com.google.protobuf.ByteString[Output Only] The resource URL for the security policy associated with this backend service.This field specifies the security settings that apply to this backend service.This field specifies the security settings that apply to this backend service.[Output Only] Server-defined URL for the resource.com.google.protobuf.ByteString[Output Only] Server-defined URL for the resource.intgetServiceBindings(int index) URLs of networkservices.ServiceBinding resources.com.google.protobuf.ByteStringgetServiceBindingsBytes(int index) URLs of networkservices.ServiceBinding resources.intURLs of networkservices.ServiceBinding resources.com.google.protobuf.ProtocolStringListURLs of networkservices.ServiceBinding resources.URL to networkservices.ServiceLbPolicy resource.com.google.protobuf.ByteStringURL to networkservices.ServiceLbPolicy resource.Type of session affinity to use.com.google.protobuf.ByteStringType of session affinity to use.Describes the HTTP cookie used for stateful session affinity.Describes the HTTP cookie used for stateful session affinity.subsetting cannot be specified with haPolicy.subsetting cannot be specified with haPolicy.intThe backend service timeout has a different meaning depending on the type of load balancer.Configuration for Backend Authenticated TLS and mTLS.Configuration for Backend Authenticated TLS and mTLS.getUsedBy(int index) Output only.intOutput only.Output only.getUsedByOrBuilder(int index) Output only.List<? extends BackendServiceUsedByOrBuilder>Output only.booleanLifetime of cookies in seconds.booleanCloud CDN configuration for this BackendService.booleanoptional .google.cloud.compute.v1.CircuitBreakers circuit_breakers = 421340061;booleanCompress text responses using Brotli or gzip compression, based on the client's Accept-Encoding header.booleanconnectionDraining cannot be specified with haPolicy.booleanConnection Tracking configuration for this BackendService.booleanConsistent Hash-based load balancing can be used to provide soft session affinity based on HTTP headers, cookies or other properties.booleanOutput only.booleanAn optional description of this resource.boolean[Output Only] The resource URL for the edge security policy associated with this backend service.booleanIf true, enables Cloud CDN for the backend service of a global external Application Load Balancer.booleanSpecifies the canary migration state.booleanDetermines the fraction of requests that should be processed by the Global external Application Load Balancer.booleanRequires at least one backend instance group to be defined as a backup (failover) backend.booleanFingerprint of this resource.booleanConfigures self-managed High Availability (HA) for External and Internal Protocol Forwarding.inthashCode()booleanhasIap()The configurations for Identity-Aware Proxy on this resource.booleanhasId()[Output Only] The unique identifier for the resource.booleanSpecifies a preference for traffic sent from the proxy to the backend (or from the client to the backend for proxyless gRPC).booleanhasKind()Output only.booleanSpecifies the load balancer type.booleanThe load balancing algorithm used within the scope of the locality.booleanThis field denotes the logging options for the load balancer traffic served by this backend service.booleanSpecifies the default maximum duration (timeout) for streams to this service.booleanhasName()Name of the resource.booleanThe URL of the network to which this backend service belongs.booleanConfigures traffic steering properties of internal passthrough Network Load Balancers.booleanInformation about the resource or system that manages the backend service.booleanSettings 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.booleanInput only.booleanhasPort()Deprecated in favor of portName.booleanA named port on a backend instance group representing the port for communication to the backend VMs in that group.booleanThe protocol this BackendService uses to communicate with backends.booleanOutput only.boolean[Output Only] The resource URL for the security policy associated with this backend service.booleanThis field specifies the security settings that apply to this backend service.boolean[Output Only] Server-defined URL for the resource.booleanURL to networkservices.ServiceLbPolicy resource.booleanType of session affinity to use.booleanDescribes the HTTP cookie used for stateful session affinity.booleansubsetting cannot be specified with haPolicy.booleanThe backend service timeout has a different meaning depending on the type of load balancer.booleanConfiguration for Backend Authenticated TLS and mTLS.protected com.google.protobuf.GeneratedMessage.FieldAccessorTableprotected com.google.protobuf.MapFieldReflectionAccessorinternalGetMapFieldReflection(int number) final booleanstatic BackendService.Builderstatic BackendService.BuildernewBuilder(BackendService prototype) protected BackendService.BuildernewBuilderForType(com.google.protobuf.AbstractMessage.BuilderParent parent) static BackendServiceparseDelimitedFrom(InputStream input) static BackendServiceparseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) static BackendServiceparseFrom(byte[] data) static BackendServiceparseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) static BackendServiceparseFrom(com.google.protobuf.ByteString data) static BackendServiceparseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) static BackendServiceparseFrom(com.google.protobuf.CodedInputStream input) static BackendServiceparseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) static BackendServiceparseFrom(InputStream input) static BackendServiceparseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) static BackendServiceparseFrom(ByteBuffer data) static BackendServiceparseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) static com.google.protobuf.Parser<BackendService>parser()voidwriteTo(com.google.protobuf.CodedOutputStream output) Methods inherited from class com.google.protobuf.GeneratedMessage
canUseUnsafe, computeStringSize, computeStringSizeNoTag, emptyBooleanList, emptyDoubleList, emptyFloatList, emptyIntList, emptyList, emptyLongList, getAllFields, getDescriptorForType, getField, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof, internalGetMapField, isStringEmpty, makeExtensionsImmutable, makeMutableCopy, makeMutableCopy, mergeFromAndMakeImmutableInternal, newFileScopedGeneratedExtension, newInstance, newMessageScopedGeneratedExtension, parseDelimitedWithIOException, parseDelimitedWithIOException, parseUnknownField, parseUnknownFieldProto3, parseWithIOException, parseWithIOException, parseWithIOException, parseWithIOException, serializeBooleanMapTo, serializeIntegerMapTo, serializeLongMapTo, serializeStringMapTo, writeReplace, writeString, writeStringNoTagMethods inherited from class com.google.protobuf.AbstractMessage
findInitializationErrors, getInitializationErrorString, hashFields, toStringMethods inherited from class com.google.protobuf.AbstractMessageLite
addAll, checkByteStringIsUtf8, toByteArray, toByteString, writeDelimitedTo, writeToMethods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, waitMethods inherited from interface com.google.protobuf.MessageLite
toByteArray, toByteString, writeDelimitedTo, writeToMethods inherited from interface com.google.protobuf.MessageOrBuilder
findInitializationErrors, getAllFields, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof
-
Field Details
-
AFFINITY_COOKIE_TTL_SEC_FIELD_NUMBER
public static final int AFFINITY_COOKIE_TTL_SEC_FIELD_NUMBER- See Also:
-
BACKENDS_FIELD_NUMBER
public static final int BACKENDS_FIELD_NUMBER- See Also:
-
CDN_POLICY_FIELD_NUMBER
public static final int CDN_POLICY_FIELD_NUMBER- See Also:
-
CIRCUIT_BREAKERS_FIELD_NUMBER
public static final int CIRCUIT_BREAKERS_FIELD_NUMBER- See Also:
-
COMPRESSION_MODE_FIELD_NUMBER
public static final int COMPRESSION_MODE_FIELD_NUMBER- See Also:
-
CONNECTION_DRAINING_FIELD_NUMBER
public static final int CONNECTION_DRAINING_FIELD_NUMBER- See Also:
-
CONNECTION_TRACKING_POLICY_FIELD_NUMBER
public static final int CONNECTION_TRACKING_POLICY_FIELD_NUMBER- See Also:
-
CONSISTENT_HASH_FIELD_NUMBER
public static final int CONSISTENT_HASH_FIELD_NUMBER- See Also:
-
CREATION_TIMESTAMP_FIELD_NUMBER
public static final int CREATION_TIMESTAMP_FIELD_NUMBER- See Also:
-
CUSTOM_METRICS_FIELD_NUMBER
public static final int CUSTOM_METRICS_FIELD_NUMBER- See Also:
-
CUSTOM_REQUEST_HEADERS_FIELD_NUMBER
public static final int CUSTOM_REQUEST_HEADERS_FIELD_NUMBER- See Also:
-
CUSTOM_RESPONSE_HEADERS_FIELD_NUMBER
public static final int CUSTOM_RESPONSE_HEADERS_FIELD_NUMBER- See Also:
-
DESCRIPTION_FIELD_NUMBER
public static final int DESCRIPTION_FIELD_NUMBER- See Also:
-
EDGE_SECURITY_POLICY_FIELD_NUMBER
public static final int EDGE_SECURITY_POLICY_FIELD_NUMBER- See Also:
-
ENABLE_C_D_N_FIELD_NUMBER
public static final int ENABLE_C_D_N_FIELD_NUMBER- See Also:
-
EXTERNAL_MANAGED_MIGRATION_STATE_FIELD_NUMBER
public static final int EXTERNAL_MANAGED_MIGRATION_STATE_FIELD_NUMBER- See Also:
-
EXTERNAL_MANAGED_MIGRATION_TESTING_PERCENTAGE_FIELD_NUMBER
public static final int EXTERNAL_MANAGED_MIGRATION_TESTING_PERCENTAGE_FIELD_NUMBER- See Also:
-
FAILOVER_POLICY_FIELD_NUMBER
public static final int FAILOVER_POLICY_FIELD_NUMBER- See Also:
-
FINGERPRINT_FIELD_NUMBER
public static final int FINGERPRINT_FIELD_NUMBER- See Also:
-
HA_POLICY_FIELD_NUMBER
public static final int HA_POLICY_FIELD_NUMBER- See Also:
-
HEALTH_CHECKS_FIELD_NUMBER
public static final int HEALTH_CHECKS_FIELD_NUMBER- See Also:
-
IAP_FIELD_NUMBER
public static final int IAP_FIELD_NUMBER- See Also:
-
ID_FIELD_NUMBER
public static final int ID_FIELD_NUMBER- See Also:
-
IP_ADDRESS_SELECTION_POLICY_FIELD_NUMBER
public static final int IP_ADDRESS_SELECTION_POLICY_FIELD_NUMBER- See Also:
-
KIND_FIELD_NUMBER
public static final int KIND_FIELD_NUMBER- See Also:
-
LOAD_BALANCING_SCHEME_FIELD_NUMBER
public static final int LOAD_BALANCING_SCHEME_FIELD_NUMBER- See Also:
-
LOCALITY_LB_POLICIES_FIELD_NUMBER
public static final int LOCALITY_LB_POLICIES_FIELD_NUMBER- See Also:
-
LOCALITY_LB_POLICY_FIELD_NUMBER
public static final int LOCALITY_LB_POLICY_FIELD_NUMBER- See Also:
-
LOG_CONFIG_FIELD_NUMBER
public static final int LOG_CONFIG_FIELD_NUMBER- See Also:
-
MAX_STREAM_DURATION_FIELD_NUMBER
public static final int MAX_STREAM_DURATION_FIELD_NUMBER- See Also:
-
METADATAS_FIELD_NUMBER
public static final int METADATAS_FIELD_NUMBER- See Also:
-
NAME_FIELD_NUMBER
public static final int NAME_FIELD_NUMBER- See Also:
-
NETWORK_FIELD_NUMBER
public static final int NETWORK_FIELD_NUMBER- See Also:
-
NETWORK_PASS_THROUGH_LB_TRAFFIC_POLICY_FIELD_NUMBER
public static final int NETWORK_PASS_THROUGH_LB_TRAFFIC_POLICY_FIELD_NUMBER- See Also:
-
ORCHESTRATION_INFO_FIELD_NUMBER
public static final int ORCHESTRATION_INFO_FIELD_NUMBER- See Also:
-
OUTLIER_DETECTION_FIELD_NUMBER
public static final int OUTLIER_DETECTION_FIELD_NUMBER- See Also:
-
PARAMS_FIELD_NUMBER
public static final int PARAMS_FIELD_NUMBER- See Also:
-
PORT_FIELD_NUMBER
public static final int PORT_FIELD_NUMBER- See Also:
-
PORT_NAME_FIELD_NUMBER
public static final int PORT_NAME_FIELD_NUMBER- See Also:
-
PROTOCOL_FIELD_NUMBER
public static final int PROTOCOL_FIELD_NUMBER- See Also:
-
REGION_FIELD_NUMBER
public static final int REGION_FIELD_NUMBER- See Also:
-
SECURITY_POLICY_FIELD_NUMBER
public static final int SECURITY_POLICY_FIELD_NUMBER- See Also:
-
SECURITY_SETTINGS_FIELD_NUMBER
public static final int SECURITY_SETTINGS_FIELD_NUMBER- See Also:
-
SELF_LINK_FIELD_NUMBER
public static final int SELF_LINK_FIELD_NUMBER- See Also:
-
SERVICE_BINDINGS_FIELD_NUMBER
public static final int SERVICE_BINDINGS_FIELD_NUMBER- See Also:
-
SERVICE_LB_POLICY_FIELD_NUMBER
public static final int SERVICE_LB_POLICY_FIELD_NUMBER- See Also:
-
SESSION_AFFINITY_FIELD_NUMBER
public static final int SESSION_AFFINITY_FIELD_NUMBER- See Also:
-
STRONG_SESSION_AFFINITY_COOKIE_FIELD_NUMBER
public static final int STRONG_SESSION_AFFINITY_COOKIE_FIELD_NUMBER- See Also:
-
SUBSETTING_FIELD_NUMBER
public static final int SUBSETTING_FIELD_NUMBER- See Also:
-
TIMEOUT_SEC_FIELD_NUMBER
public static final int TIMEOUT_SEC_FIELD_NUMBER- See Also:
-
TLS_SETTINGS_FIELD_NUMBER
public static final int TLS_SETTINGS_FIELD_NUMBER- See Also:
-
USED_BY_FIELD_NUMBER
public static final int USED_BY_FIELD_NUMBER- See Also:
-
-
Method Details
-
getDescriptor
public static final com.google.protobuf.Descriptors.Descriptor getDescriptor() -
internalGetMapFieldReflection
protected com.google.protobuf.MapFieldReflectionAccessor internalGetMapFieldReflection(int number) - Overrides:
internalGetMapFieldReflectionin classcom.google.protobuf.GeneratedMessage
-
internalGetFieldAccessorTable
protected com.google.protobuf.GeneratedMessage.FieldAccessorTable internalGetFieldAccessorTable()- Specified by:
internalGetFieldAccessorTablein classcom.google.protobuf.GeneratedMessage
-
hasAffinityCookieTtlSec
public boolean hasAffinityCookieTtlSec()Lifetime of cookies in seconds. This setting is applicable to Application Load Balancers and Traffic Director and requires GENERATED_COOKIE or HTTP_COOKIE session affinity. If set to 0, the cookie is non-persistent and lasts only until the end of the browser session (or equivalent). The maximum allowed value is two weeks (1,209,600). Not supported when the backend service is referenced by a URL map that is bound to target gRPC proxy that has validateForProxyless field set to true.
optional int32 affinity_cookie_ttl_sec = 369996954;- Specified by:
hasAffinityCookieTtlSecin interfaceBackendServiceOrBuilder- Returns:
- Whether the affinityCookieTtlSec field is set.
-
getAffinityCookieTtlSec
public int getAffinityCookieTtlSec()Lifetime of cookies in seconds. This setting is applicable to Application Load Balancers and Traffic Director and requires GENERATED_COOKIE or HTTP_COOKIE session affinity. If set to 0, the cookie is non-persistent and lasts only until the end of the browser session (or equivalent). The maximum allowed value is two weeks (1,209,600). Not supported when the backend service is referenced by a URL map that is bound to target gRPC proxy that has validateForProxyless field set to true.
optional int32 affinity_cookie_ttl_sec = 369996954;- Specified by:
getAffinityCookieTtlSecin interfaceBackendServiceOrBuilder- Returns:
- The affinityCookieTtlSec.
-
getBackendsList
The list of backends that serve this BackendService.
repeated .google.cloud.compute.v1.Backend backends = 510839903;- Specified by:
getBackendsListin interfaceBackendServiceOrBuilder
-
getBackendsOrBuilderList
The list of backends that serve this BackendService.
repeated .google.cloud.compute.v1.Backend backends = 510839903;- Specified by:
getBackendsOrBuilderListin interfaceBackendServiceOrBuilder
-
getBackendsCount
public int getBackendsCount()The list of backends that serve this BackendService.
repeated .google.cloud.compute.v1.Backend backends = 510839903;- Specified by:
getBackendsCountin interfaceBackendServiceOrBuilder
-
getBackends
The list of backends that serve this BackendService.
repeated .google.cloud.compute.v1.Backend backends = 510839903;- Specified by:
getBackendsin interfaceBackendServiceOrBuilder
-
getBackendsOrBuilder
The list of backends that serve this BackendService.
repeated .google.cloud.compute.v1.Backend backends = 510839903;- Specified by:
getBackendsOrBuilderin interfaceBackendServiceOrBuilder
-
hasCdnPolicy
public boolean hasCdnPolicy()Cloud CDN configuration for this BackendService. Only available for specified load balancer types.
optional .google.cloud.compute.v1.BackendServiceCdnPolicy cdn_policy = 213976452;- Specified by:
hasCdnPolicyin interfaceBackendServiceOrBuilder- Returns:
- Whether the cdnPolicy field is set.
-
getCdnPolicy
Cloud CDN configuration for this BackendService. Only available for specified load balancer types.
optional .google.cloud.compute.v1.BackendServiceCdnPolicy cdn_policy = 213976452;- Specified by:
getCdnPolicyin interfaceBackendServiceOrBuilder- Returns:
- The cdnPolicy.
-
getCdnPolicyOrBuilder
Cloud CDN configuration for this BackendService. Only available for specified load balancer types.
optional .google.cloud.compute.v1.BackendServiceCdnPolicy cdn_policy = 213976452;- Specified by:
getCdnPolicyOrBuilderin interfaceBackendServiceOrBuilder
-
hasCircuitBreakers
public boolean hasCircuitBreakers()optional .google.cloud.compute.v1.CircuitBreakers circuit_breakers = 421340061;- Specified by:
hasCircuitBreakersin interfaceBackendServiceOrBuilder- Returns:
- Whether the circuitBreakers field is set.
-
getCircuitBreakers
optional .google.cloud.compute.v1.CircuitBreakers circuit_breakers = 421340061;- Specified by:
getCircuitBreakersin interfaceBackendServiceOrBuilder- Returns:
- The circuitBreakers.
-
getCircuitBreakersOrBuilder
optional .google.cloud.compute.v1.CircuitBreakers circuit_breakers = 421340061;- Specified by:
getCircuitBreakersOrBuilderin interfaceBackendServiceOrBuilder
-
hasCompressionMode
public boolean hasCompressionMode()Compress text responses using Brotli or gzip compression, based on the client's Accept-Encoding header. Check the CompressionMode enum for the list of possible values.
optional string compression_mode = 95520988;- Specified by:
hasCompressionModein interfaceBackendServiceOrBuilder- Returns:
- Whether the compressionMode field is set.
-
getCompressionMode
Compress text responses using Brotli or gzip compression, based on the client's Accept-Encoding header. Check the CompressionMode enum for the list of possible values.
optional string compression_mode = 95520988;- Specified by:
getCompressionModein interfaceBackendServiceOrBuilder- Returns:
- The compressionMode.
-
getCompressionModeBytes
public com.google.protobuf.ByteString getCompressionModeBytes()Compress text responses using Brotli or gzip compression, based on the client's Accept-Encoding header. Check the CompressionMode enum for the list of possible values.
optional string compression_mode = 95520988;- Specified by:
getCompressionModeBytesin interfaceBackendServiceOrBuilder- Returns:
- The bytes for compressionMode.
-
hasConnectionDraining
public boolean hasConnectionDraining()connectionDraining cannot be specified with haPolicy.
optional .google.cloud.compute.v1.ConnectionDraining connection_draining = 461096747;- Specified by:
hasConnectionDrainingin interfaceBackendServiceOrBuilder- Returns:
- Whether the connectionDraining field is set.
-
getConnectionDraining
connectionDraining cannot be specified with haPolicy.
optional .google.cloud.compute.v1.ConnectionDraining connection_draining = 461096747;- Specified by:
getConnectionDrainingin interfaceBackendServiceOrBuilder- Returns:
- The connectionDraining.
-
getConnectionDrainingOrBuilder
connectionDraining cannot be specified with haPolicy.
optional .google.cloud.compute.v1.ConnectionDraining connection_draining = 461096747;- Specified by:
getConnectionDrainingOrBuilderin interfaceBackendServiceOrBuilder
-
hasConnectionTrackingPolicy
public boolean hasConnectionTrackingPolicy()Connection Tracking configuration for this BackendService. Connection tracking policy settings are only available for external passthrough Network Load Balancers and internal passthrough Network Load Balancers. connectionTrackingPolicy cannot be specified with haPolicy.
optional .google.cloud.compute.v1.BackendServiceConnectionTrackingPolicy connection_tracking_policy = 143994969;- Specified by:
hasConnectionTrackingPolicyin interfaceBackendServiceOrBuilder- Returns:
- Whether the connectionTrackingPolicy field is set.
-
getConnectionTrackingPolicy
Connection Tracking configuration for this BackendService. Connection tracking policy settings are only available for external passthrough Network Load Balancers and internal passthrough Network Load Balancers. connectionTrackingPolicy cannot be specified with haPolicy.
optional .google.cloud.compute.v1.BackendServiceConnectionTrackingPolicy connection_tracking_policy = 143994969;- Specified by:
getConnectionTrackingPolicyin interfaceBackendServiceOrBuilder- Returns:
- The connectionTrackingPolicy.
-
getConnectionTrackingPolicyOrBuilder
Connection Tracking configuration for this BackendService. Connection tracking policy settings are only available for external passthrough Network Load Balancers and internal passthrough Network Load Balancers. connectionTrackingPolicy cannot be specified with haPolicy.
optional .google.cloud.compute.v1.BackendServiceConnectionTrackingPolicy connection_tracking_policy = 143994969;- Specified by:
getConnectionTrackingPolicyOrBuilderin interfaceBackendServiceOrBuilder
-
hasConsistentHash
public boolean hasConsistentHash()Consistent Hash-based load balancing can be used to provide soft session affinity based on HTTP headers, cookies or other properties. This load balancing policy is applicable only for HTTP connections. The affinity to a particular destination host will be lost when one or more hosts are added/removed from the destination service. This field specifies parameters that control consistent hashing. This field is only applicable whenlocalityLbPolicy is set to MAGLEV orRING_HASH. This field is applicable to either: - A regional backend service with the service protocol set to HTTP, HTTPS, HTTP2 or H2C, and load_balancing_scheme set to INTERNAL_MANAGED. - A global backend service with the load_balancing_scheme set to INTERNAL_SELF_MANAGED.
optional .google.cloud.compute.v1.ConsistentHashLoadBalancerSettings consistent_hash = 905883;- Specified by:
hasConsistentHashin interfaceBackendServiceOrBuilder- Returns:
- Whether the consistentHash field is set.
-
getConsistentHash
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 whenlocalityLbPolicy is set to MAGLEV orRING_HASH. This field is applicable to either: - A regional backend service with the service protocol set to HTTP, HTTPS, HTTP2 or H2C, and load_balancing_scheme set to INTERNAL_MANAGED. - A global backend service with the load_balancing_scheme set to INTERNAL_SELF_MANAGED.
optional .google.cloud.compute.v1.ConsistentHashLoadBalancerSettings consistent_hash = 905883;- Specified by:
getConsistentHashin interfaceBackendServiceOrBuilder- Returns:
- The consistentHash.
-
getConsistentHashOrBuilder
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 whenlocalityLbPolicy is set to MAGLEV orRING_HASH. This field is applicable to either: - A regional backend service with the service protocol set to HTTP, HTTPS, HTTP2 or H2C, and load_balancing_scheme set to INTERNAL_MANAGED. - A global backend service with the load_balancing_scheme set to INTERNAL_SELF_MANAGED.
optional .google.cloud.compute.v1.ConsistentHashLoadBalancerSettings consistent_hash = 905883;- Specified by:
getConsistentHashOrBuilderin interfaceBackendServiceOrBuilder
-
hasCreationTimestamp
public boolean hasCreationTimestamp()Output only. [Output Only] Creation timestamp inRFC3339 text format.
optional string creation_timestamp = 30525366;- Specified by:
hasCreationTimestampin interfaceBackendServiceOrBuilder- Returns:
- Whether the creationTimestamp field is set.
-
getCreationTimestamp
Output only. [Output Only] Creation timestamp inRFC3339 text format.
optional string creation_timestamp = 30525366;- Specified by:
getCreationTimestampin interfaceBackendServiceOrBuilder- Returns:
- The creationTimestamp.
-
getCreationTimestampBytes
public com.google.protobuf.ByteString getCreationTimestampBytes()Output only. [Output Only] Creation timestamp inRFC3339 text format.
optional string creation_timestamp = 30525366;- Specified by:
getCreationTimestampBytesin interfaceBackendServiceOrBuilder- Returns:
- The bytes for creationTimestamp.
-
getCustomMetricsList
List of custom metrics that are used for theWEIGHTED_ROUND_ROBIN locality_lb_policy.
repeated .google.cloud.compute.v1.BackendServiceCustomMetric custom_metrics = 429453813;- Specified by:
getCustomMetricsListin interfaceBackendServiceOrBuilder
-
getCustomMetricsOrBuilderList
List of custom metrics that are used for theWEIGHTED_ROUND_ROBIN locality_lb_policy.
repeated .google.cloud.compute.v1.BackendServiceCustomMetric custom_metrics = 429453813;- Specified by:
getCustomMetricsOrBuilderListin interfaceBackendServiceOrBuilder
-
getCustomMetricsCount
public int getCustomMetricsCount()List of custom metrics that are used for theWEIGHTED_ROUND_ROBIN locality_lb_policy.
repeated .google.cloud.compute.v1.BackendServiceCustomMetric custom_metrics = 429453813;- Specified by:
getCustomMetricsCountin interfaceBackendServiceOrBuilder
-
getCustomMetrics
List of custom metrics that are used for theWEIGHTED_ROUND_ROBIN locality_lb_policy.
repeated .google.cloud.compute.v1.BackendServiceCustomMetric custom_metrics = 429453813;- Specified by:
getCustomMetricsin interfaceBackendServiceOrBuilder
-
getCustomMetricsOrBuilder
List of custom metrics that are used for theWEIGHTED_ROUND_ROBIN locality_lb_policy.
repeated .google.cloud.compute.v1.BackendServiceCustomMetric custom_metrics = 429453813;- Specified by:
getCustomMetricsOrBuilderin interfaceBackendServiceOrBuilder
-
getCustomRequestHeadersList
public com.google.protobuf.ProtocolStringList getCustomRequestHeadersList()Headers that the load balancer adds to proxied requests. See [Creating custom headers](https://cloud.google.com/load-balancing/docs/custom-headers).
repeated string custom_request_headers = 27977992;- Specified by:
getCustomRequestHeadersListin interfaceBackendServiceOrBuilder- Returns:
- A list containing the customRequestHeaders.
-
getCustomRequestHeadersCount
public int getCustomRequestHeadersCount()Headers that the load balancer adds to proxied requests. See [Creating custom headers](https://cloud.google.com/load-balancing/docs/custom-headers).
repeated string custom_request_headers = 27977992;- Specified by:
getCustomRequestHeadersCountin interfaceBackendServiceOrBuilder- Returns:
- The count of customRequestHeaders.
-
getCustomRequestHeaders
Headers that the load balancer adds to proxied requests. See [Creating custom headers](https://cloud.google.com/load-balancing/docs/custom-headers).
repeated string custom_request_headers = 27977992;- Specified by:
getCustomRequestHeadersin interfaceBackendServiceOrBuilder- Parameters:
index- The index of the element to return.- Returns:
- The customRequestHeaders at the given index.
-
getCustomRequestHeadersBytes
public com.google.protobuf.ByteString getCustomRequestHeadersBytes(int index) Headers that the load balancer adds to proxied requests. See [Creating custom headers](https://cloud.google.com/load-balancing/docs/custom-headers).
repeated string custom_request_headers = 27977992;- Specified by:
getCustomRequestHeadersBytesin interfaceBackendServiceOrBuilder- Parameters:
index- The index of the value to return.- Returns:
- The bytes of the customRequestHeaders at the given index.
-
getCustomResponseHeadersList
public com.google.protobuf.ProtocolStringList getCustomResponseHeadersList()Headers that the load balancer adds to proxied responses. See [Creating custom headers](https://cloud.google.com/load-balancing/docs/custom-headers).
repeated string custom_response_headers = 387539094;- Specified by:
getCustomResponseHeadersListin interfaceBackendServiceOrBuilder- Returns:
- A list containing the customResponseHeaders.
-
getCustomResponseHeadersCount
public int getCustomResponseHeadersCount()Headers that the load balancer adds to proxied responses. See [Creating custom headers](https://cloud.google.com/load-balancing/docs/custom-headers).
repeated string custom_response_headers = 387539094;- Specified by:
getCustomResponseHeadersCountin interfaceBackendServiceOrBuilder- Returns:
- The count of customResponseHeaders.
-
getCustomResponseHeaders
Headers that the load balancer adds to proxied responses. See [Creating custom headers](https://cloud.google.com/load-balancing/docs/custom-headers).
repeated string custom_response_headers = 387539094;- Specified by:
getCustomResponseHeadersin interfaceBackendServiceOrBuilder- Parameters:
index- The index of the element to return.- Returns:
- The customResponseHeaders at the given index.
-
getCustomResponseHeadersBytes
public com.google.protobuf.ByteString getCustomResponseHeadersBytes(int index) Headers that the load balancer adds to proxied responses. See [Creating custom headers](https://cloud.google.com/load-balancing/docs/custom-headers).
repeated string custom_response_headers = 387539094;- Specified by:
getCustomResponseHeadersBytesin interfaceBackendServiceOrBuilder- Parameters:
index- The index of the value to return.- Returns:
- The bytes of the customResponseHeaders at the given index.
-
hasDescription
public boolean hasDescription()An optional description of this resource. Provide this property when you create the resource.
optional string description = 422937596;- Specified by:
hasDescriptionin interfaceBackendServiceOrBuilder- Returns:
- Whether the description field is set.
-
getDescription
An optional description of this resource. Provide this property when you create the resource.
optional string description = 422937596;- Specified by:
getDescriptionin interfaceBackendServiceOrBuilder- Returns:
- The description.
-
getDescriptionBytes
public com.google.protobuf.ByteString getDescriptionBytes()An optional description of this resource. Provide this property when you create the resource.
optional string description = 422937596;- Specified by:
getDescriptionBytesin interfaceBackendServiceOrBuilder- Returns:
- The bytes for description.
-
hasEdgeSecurityPolicy
public boolean hasEdgeSecurityPolicy()[Output Only] The resource URL for the edge security policy associated with this backend service.
optional string edge_security_policy = 41036943;- Specified by:
hasEdgeSecurityPolicyin interfaceBackendServiceOrBuilder- Returns:
- Whether the edgeSecurityPolicy field is set.
-
getEdgeSecurityPolicy
[Output Only] The resource URL for the edge security policy associated with this backend service.
optional string edge_security_policy = 41036943;- Specified by:
getEdgeSecurityPolicyin interfaceBackendServiceOrBuilder- Returns:
- The edgeSecurityPolicy.
-
getEdgeSecurityPolicyBytes
public com.google.protobuf.ByteString getEdgeSecurityPolicyBytes()[Output Only] The resource URL for the edge security policy associated with this backend service.
optional string edge_security_policy = 41036943;- Specified by:
getEdgeSecurityPolicyBytesin interfaceBackendServiceOrBuilder- Returns:
- The bytes for edgeSecurityPolicy.
-
hasEnableCDN
public boolean hasEnableCDN()If true, enables Cloud CDN for the backend service of a global external Application Load Balancer.
optional bool enable_c_d_n = 250733499;- Specified by:
hasEnableCDNin interfaceBackendServiceOrBuilder- Returns:
- Whether the enableCDN field is set.
-
getEnableCDN
public boolean getEnableCDN()If true, enables Cloud CDN for the backend service of a global external Application Load Balancer.
optional bool enable_c_d_n = 250733499;- Specified by:
getEnableCDNin interfaceBackendServiceOrBuilder- Returns:
- The enableCDN.
-
hasExternalManagedMigrationState
public boolean hasExternalManagedMigrationState()Specifies the canary migration state. Possible values are PREPARE, TEST_BY_PERCENTAGE, and TEST_ALL_TRAFFIC. To begin the migration from EXTERNAL to EXTERNAL_MANAGED, the state must be changed to PREPARE. The state must be changed to TEST_ALL_TRAFFIC before the loadBalancingScheme can be changed to EXTERNAL_MANAGED. Optionally, the TEST_BY_PERCENTAGE state can be used to migrate traffic by percentage using externalManagedMigrationTestingPercentage. Rolling back a migration requires the states to be set in reverse order. So changing the scheme from EXTERNAL_MANAGED to EXTERNAL requires the state to be set to TEST_ALL_TRAFFIC at the same time. Optionally, the TEST_BY_PERCENTAGE state can be used to migrate some traffic back to EXTERNAL or PREPARE can be used to migrate all traffic back to EXTERNAL. Check the ExternalManagedMigrationState enum for the list of possible values.
optional string external_managed_migration_state = 66947020;- Specified by:
hasExternalManagedMigrationStatein interfaceBackendServiceOrBuilder- Returns:
- Whether the externalManagedMigrationState field is set.
-
getExternalManagedMigrationState
Specifies the canary migration state. Possible values are PREPARE, TEST_BY_PERCENTAGE, and TEST_ALL_TRAFFIC. To begin the migration from EXTERNAL to EXTERNAL_MANAGED, the state must be changed to PREPARE. The state must be changed to TEST_ALL_TRAFFIC before the loadBalancingScheme can be changed to EXTERNAL_MANAGED. Optionally, the TEST_BY_PERCENTAGE state can be used to migrate traffic by percentage using externalManagedMigrationTestingPercentage. Rolling back a migration requires the states to be set in reverse order. So changing the scheme from EXTERNAL_MANAGED to EXTERNAL requires the state to be set to TEST_ALL_TRAFFIC at the same time. Optionally, the TEST_BY_PERCENTAGE state can be used to migrate some traffic back to EXTERNAL or PREPARE can be used to migrate all traffic back to EXTERNAL. Check the ExternalManagedMigrationState enum for the list of possible values.
optional string external_managed_migration_state = 66947020;- Specified by:
getExternalManagedMigrationStatein interfaceBackendServiceOrBuilder- Returns:
- The externalManagedMigrationState.
-
getExternalManagedMigrationStateBytes
public com.google.protobuf.ByteString getExternalManagedMigrationStateBytes()Specifies the canary migration state. Possible values are PREPARE, TEST_BY_PERCENTAGE, and TEST_ALL_TRAFFIC. To begin the migration from EXTERNAL to EXTERNAL_MANAGED, the state must be changed to PREPARE. The state must be changed to TEST_ALL_TRAFFIC before the loadBalancingScheme can be changed to EXTERNAL_MANAGED. Optionally, the TEST_BY_PERCENTAGE state can be used to migrate traffic by percentage using externalManagedMigrationTestingPercentage. Rolling back a migration requires the states to be set in reverse order. So changing the scheme from EXTERNAL_MANAGED to EXTERNAL requires the state to be set to TEST_ALL_TRAFFIC at the same time. Optionally, the TEST_BY_PERCENTAGE state can be used to migrate some traffic back to EXTERNAL or PREPARE can be used to migrate all traffic back to EXTERNAL. Check the ExternalManagedMigrationState enum for the list of possible values.
optional string external_managed_migration_state = 66947020;- Specified by:
getExternalManagedMigrationStateBytesin interfaceBackendServiceOrBuilder- Returns:
- The bytes for externalManagedMigrationState.
-
hasExternalManagedMigrationTestingPercentage
public boolean hasExternalManagedMigrationTestingPercentage()Determines the fraction of requests that should be processed by the Global external Application Load Balancer. The value of this field must be in the range [0, 100]. Session affinity options will slightly affect this routing behavior, for more details, see:Session Affinity. This value can only be set if the loadBalancingScheme in the BackendService is set to EXTERNAL (when using the classic Application Load Balancer) and the migration state is TEST_BY_PERCENTAGE.
optional float external_managed_migration_testing_percentage = 507232462;- Specified by:
hasExternalManagedMigrationTestingPercentagein interfaceBackendServiceOrBuilder- Returns:
- Whether the externalManagedMigrationTestingPercentage field is set.
-
getExternalManagedMigrationTestingPercentage
public float getExternalManagedMigrationTestingPercentage()Determines the fraction of requests that should be processed by the Global external Application Load Balancer. The value of this field must be in the range [0, 100]. Session affinity options will slightly affect this routing behavior, for more details, see:Session Affinity. This value can only be set if the loadBalancingScheme in the BackendService is set to EXTERNAL (when using the classic Application Load Balancer) and the migration state is TEST_BY_PERCENTAGE.
optional float external_managed_migration_testing_percentage = 507232462;- Specified by:
getExternalManagedMigrationTestingPercentagein interfaceBackendServiceOrBuilder- Returns:
- The externalManagedMigrationTestingPercentage.
-
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 passthrough Network Load Balancers](https://cloud.google.com/load-balancing/docs/internal/failover-overview) and [external passthrough Network Load Balancers](https://cloud.google.com/load-balancing/docs/network/networklb-failover-overview). failoverPolicy cannot be specified with haPolicy.
optional .google.cloud.compute.v1.BackendServiceFailoverPolicy failover_policy = 105658655;- Specified by:
hasFailoverPolicyin interfaceBackendServiceOrBuilder- Returns:
- Whether the failoverPolicy field is set.
-
getFailoverPolicy
Requires at least one backend instance group to be defined as a backup (failover) backend. For load balancers that have configurable failover: [Internal passthrough Network Load Balancers](https://cloud.google.com/load-balancing/docs/internal/failover-overview) and [external passthrough Network Load Balancers](https://cloud.google.com/load-balancing/docs/network/networklb-failover-overview). failoverPolicy cannot be specified with haPolicy.
optional .google.cloud.compute.v1.BackendServiceFailoverPolicy failover_policy = 105658655;- Specified by:
getFailoverPolicyin interfaceBackendServiceOrBuilder- Returns:
- The failoverPolicy.
-
getFailoverPolicyOrBuilder
Requires at least one backend instance group to be defined as a backup (failover) backend. For load balancers that have configurable failover: [Internal passthrough Network Load Balancers](https://cloud.google.com/load-balancing/docs/internal/failover-overview) and [external passthrough Network Load Balancers](https://cloud.google.com/load-balancing/docs/network/networklb-failover-overview). failoverPolicy cannot be specified with haPolicy.
optional .google.cloud.compute.v1.BackendServiceFailoverPolicy failover_policy = 105658655;- Specified by:
getFailoverPolicyOrBuilderin interfaceBackendServiceOrBuilder
-
hasFingerprint
public boolean hasFingerprint()Fingerprint of this resource. A hash of the contents stored in this object. This field is used in optimistic locking. This field will be ignored when inserting a BackendService. An up-to-date fingerprint must be provided in order to update the BackendService, otherwise the request will fail with error 412 conditionNotMet. To see the latest fingerprint, make a get() request to retrieve a BackendService.
optional string fingerprint = 234678500;- Specified by:
hasFingerprintin interfaceBackendServiceOrBuilder- Returns:
- Whether the fingerprint field is set.
-
getFingerprint
Fingerprint of this resource. A hash of the contents stored in this object. This field is used in optimistic locking. This field will be ignored when inserting a BackendService. An up-to-date fingerprint must be provided in order to update the BackendService, otherwise the request will fail with error 412 conditionNotMet. To see the latest fingerprint, make a get() request to retrieve a BackendService.
optional string fingerprint = 234678500;- Specified by:
getFingerprintin interfaceBackendServiceOrBuilder- Returns:
- The fingerprint.
-
getFingerprintBytes
public com.google.protobuf.ByteString getFingerprintBytes()Fingerprint of this resource. A hash of the contents stored in this object. This field is used in optimistic locking. This field will be ignored when inserting a BackendService. An up-to-date fingerprint must be provided in order to update the BackendService, otherwise the request will fail with error 412 conditionNotMet. To see the latest fingerprint, make a get() request to retrieve a BackendService.
optional string fingerprint = 234678500;- Specified by:
getFingerprintBytesin interfaceBackendServiceOrBuilder- Returns:
- The bytes for fingerprint.
-
hasHaPolicy
public boolean hasHaPolicy()Configures self-managed High Availability (HA) for External and Internal Protocol Forwarding. The backends of this regional backend service must only specify zonal network endpoint groups (NEGs) of type GCE_VM_IP. When haPolicy is set for an Internal Passthrough Network Load Balancer, the regional backend service must set the network field. All zonal NEGs must belong to the same network. However, individual NEGs can belong to different subnetworks of that network. When haPolicy is specified, the set of attached network endpoints across all backends comprise an High Availability domain from which one endpoint is selected as the active endpoint (the leader) that receives all traffic. haPolicy can be added only at backend service creation time. Once set up, it cannot be deleted. Note that haPolicy is not for load balancing, and therefore cannot be specified with sessionAffinity, connectionTrackingPolicy, and failoverPolicy. haPolicy requires customers to be responsible for tracking backend endpoint health and electing a leader among the healthy endpoints. Therefore, haPolicy cannot be specified with healthChecks. haPolicy can only be specified for External Passthrough Network Load Balancers and Internal Passthrough Network Load Balancers.
optional .google.cloud.compute.v1.BackendServiceHAPolicy ha_policy = 519879480;- Specified by:
hasHaPolicyin interfaceBackendServiceOrBuilder- Returns:
- Whether the haPolicy field is set.
-
getHaPolicy
Configures self-managed High Availability (HA) for External and Internal Protocol Forwarding. The backends of this regional backend service must only specify zonal network endpoint groups (NEGs) of type GCE_VM_IP. When haPolicy is set for an Internal Passthrough Network Load Balancer, the regional backend service must set the network field. All zonal NEGs must belong to the same network. However, individual NEGs can belong to different subnetworks of that network. When haPolicy is specified, the set of attached network endpoints across all backends comprise an High Availability domain from which one endpoint is selected as the active endpoint (the leader) that receives all traffic. haPolicy can be added only at backend service creation time. Once set up, it cannot be deleted. Note that haPolicy is not for load balancing, and therefore cannot be specified with sessionAffinity, connectionTrackingPolicy, and failoverPolicy. haPolicy requires customers to be responsible for tracking backend endpoint health and electing a leader among the healthy endpoints. Therefore, haPolicy cannot be specified with healthChecks. haPolicy can only be specified for External Passthrough Network Load Balancers and Internal Passthrough Network Load Balancers.
optional .google.cloud.compute.v1.BackendServiceHAPolicy ha_policy = 519879480;- Specified by:
getHaPolicyin interfaceBackendServiceOrBuilder- Returns:
- The haPolicy.
-
getHaPolicyOrBuilder
Configures self-managed High Availability (HA) for External and Internal Protocol Forwarding. The backends of this regional backend service must only specify zonal network endpoint groups (NEGs) of type GCE_VM_IP. When haPolicy is set for an Internal Passthrough Network Load Balancer, the regional backend service must set the network field. All zonal NEGs must belong to the same network. However, individual NEGs can belong to different subnetworks of that network. When haPolicy is specified, the set of attached network endpoints across all backends comprise an High Availability domain from which one endpoint is selected as the active endpoint (the leader) that receives all traffic. haPolicy can be added only at backend service creation time. Once set up, it cannot be deleted. Note that haPolicy is not for load balancing, and therefore cannot be specified with sessionAffinity, connectionTrackingPolicy, and failoverPolicy. haPolicy requires customers to be responsible for tracking backend endpoint health and electing a leader among the healthy endpoints. Therefore, haPolicy cannot be specified with healthChecks. haPolicy can only be specified for External Passthrough Network Load Balancers and Internal Passthrough Network Load Balancers.
optional .google.cloud.compute.v1.BackendServiceHAPolicy ha_policy = 519879480;- Specified by:
getHaPolicyOrBuilderin interfaceBackendServiceOrBuilder
-
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 unless haPolicy is specified. Backend services with internet or serverless NEG backends must not have a health check. healthChecks[] cannot be specified with haPolicy.
repeated string health_checks = 448370606;- Specified by:
getHealthChecksListin interfaceBackendServiceOrBuilder- Returns:
- A list containing the healthChecks.
-
getHealthChecksCount
public int getHealthChecksCount()The list of URLs to the healthChecks, httpHealthChecks (legacy), or httpsHealthChecks (legacy) resource for health checking this backend service. Not all backend services support legacy health checks. See Load balancer guide. Currently, at most one health check can be specified for each backend service. Backend services with instance group or zonal NEG backends must have a health check unless haPolicy is specified. Backend services with internet or serverless NEG backends must not have a health check. healthChecks[] cannot be specified with haPolicy.
repeated string health_checks = 448370606;- Specified by:
getHealthChecksCountin interfaceBackendServiceOrBuilder- Returns:
- The count of healthChecks.
-
getHealthChecks
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 unless haPolicy is specified. Backend services with internet or serverless NEG backends must not have a health check. healthChecks[] cannot be specified with haPolicy.
repeated string health_checks = 448370606;- Specified by:
getHealthChecksin interfaceBackendServiceOrBuilder- Parameters:
index- The index of the element to return.- Returns:
- The healthChecks at the given index.
-
getHealthChecksBytes
public com.google.protobuf.ByteString getHealthChecksBytes(int index) The list of URLs to the healthChecks, httpHealthChecks (legacy), or httpsHealthChecks (legacy) resource for health checking this backend service. Not all backend services support legacy health checks. See Load balancer guide. Currently, at most one health check can be specified for each backend service. Backend services with instance group or zonal NEG backends must have a health check unless haPolicy is specified. Backend services with internet or serverless NEG backends must not have a health check. healthChecks[] cannot be specified with haPolicy.
repeated string health_checks = 448370606;- Specified by:
getHealthChecksBytesin interfaceBackendServiceOrBuilder- Parameters:
index- The index of the value to return.- Returns:
- The bytes of the healthChecks at the given index.
-
hasIap
public boolean hasIap()The configurations for Identity-Aware Proxy on this resource. Not available for internal passthrough Network Load Balancers and external passthrough Network Load Balancers.
optional .google.cloud.compute.v1.BackendServiceIAP iap = 104024;- Specified by:
hasIapin interfaceBackendServiceOrBuilder- Returns:
- Whether the iap field is set.
-
getIap
The configurations for Identity-Aware Proxy on this resource. Not available for internal passthrough Network Load Balancers and external passthrough Network Load Balancers.
optional .google.cloud.compute.v1.BackendServiceIAP iap = 104024;- Specified by:
getIapin interfaceBackendServiceOrBuilder- Returns:
- The iap.
-
getIapOrBuilder
The configurations for Identity-Aware Proxy on this resource. Not available for internal passthrough Network Load Balancers and external passthrough Network Load Balancers.
optional .google.cloud.compute.v1.BackendServiceIAP iap = 104024;- Specified by:
getIapOrBuilderin interfaceBackendServiceOrBuilder
-
hasId
public boolean hasId()[Output Only] The unique identifier for the resource. This identifier is defined by the server.
optional uint64 id = 3355;- Specified by:
hasIdin interfaceBackendServiceOrBuilder- Returns:
- Whether the id field is set.
-
getId
public long getId()[Output Only] The unique identifier for the resource. This identifier is defined by the server.
optional uint64 id = 3355;- Specified by:
getIdin interfaceBackendServiceOrBuilder- Returns:
- The id.
-
hasIpAddressSelectionPolicy
public boolean hasIpAddressSelectionPolicy()Specifies a preference for traffic sent from the proxy to the backend (or from the client to the backend for proxyless gRPC). The possible values are: - IPV4_ONLY: Only send IPv4 traffic to the backends of the backend service (Instance Group, Managed Instance Group, Network Endpoint Group), regardless of traffic from the client to the proxy. Only IPv4 health checks are used to check the health of the backends. This is the default setting. - PREFER_IPV6: Prioritize the connection to the endpoint's IPv6 address over its IPv4 address (provided there is a healthy IPv6 address). - IPV6_ONLY: Only send IPv6 traffic to the backends of the backend service (Instance Group, Managed Instance Group, Network Endpoint Group), regardless of traffic from the client to the proxy. Only IPv6 health checks are used to check the health of the backends. This field is applicable to either: - Advanced global external Application Load Balancer (load balancing scheme EXTERNAL_MANAGED), - Regional external Application Load Balancer, - Internal proxy Network Load Balancer (load balancing scheme INTERNAL_MANAGED), - Regional internal Application Load Balancer (load balancing scheme INTERNAL_MANAGED), - Traffic Director with Envoy proxies and proxyless gRPC (load balancing scheme INTERNAL_SELF_MANAGED). Check the IpAddressSelectionPolicy enum for the list of possible values.
optional string ip_address_selection_policy = 77600840;- Specified by:
hasIpAddressSelectionPolicyin interfaceBackendServiceOrBuilder- Returns:
- Whether the ipAddressSelectionPolicy field is set.
-
getIpAddressSelectionPolicy
Specifies a preference for traffic sent from the proxy to the backend (or from the client to the backend for proxyless gRPC). The possible values are: - IPV4_ONLY: Only send IPv4 traffic to the backends of the backend service (Instance Group, Managed Instance Group, Network Endpoint Group), regardless of traffic from the client to the proxy. Only IPv4 health checks are used to check the health of the backends. This is the default setting. - PREFER_IPV6: Prioritize the connection to the endpoint's IPv6 address over its IPv4 address (provided there is a healthy IPv6 address). - IPV6_ONLY: Only send IPv6 traffic to the backends of the backend service (Instance Group, Managed Instance Group, Network Endpoint Group), regardless of traffic from the client to the proxy. Only IPv6 health checks are used to check the health of the backends. This field is applicable to either: - Advanced global external Application Load Balancer (load balancing scheme EXTERNAL_MANAGED), - Regional external Application Load Balancer, - Internal proxy Network Load Balancer (load balancing scheme INTERNAL_MANAGED), - Regional internal Application Load Balancer (load balancing scheme INTERNAL_MANAGED), - Traffic Director with Envoy proxies and proxyless gRPC (load balancing scheme INTERNAL_SELF_MANAGED). Check the IpAddressSelectionPolicy enum for the list of possible values.
optional string ip_address_selection_policy = 77600840;- Specified by:
getIpAddressSelectionPolicyin interfaceBackendServiceOrBuilder- Returns:
- The ipAddressSelectionPolicy.
-
getIpAddressSelectionPolicyBytes
public com.google.protobuf.ByteString getIpAddressSelectionPolicyBytes()Specifies a preference for traffic sent from the proxy to the backend (or from the client to the backend for proxyless gRPC). The possible values are: - IPV4_ONLY: Only send IPv4 traffic to the backends of the backend service (Instance Group, Managed Instance Group, Network Endpoint Group), regardless of traffic from the client to the proxy. Only IPv4 health checks are used to check the health of the backends. This is the default setting. - PREFER_IPV6: Prioritize the connection to the endpoint's IPv6 address over its IPv4 address (provided there is a healthy IPv6 address). - IPV6_ONLY: Only send IPv6 traffic to the backends of the backend service (Instance Group, Managed Instance Group, Network Endpoint Group), regardless of traffic from the client to the proxy. Only IPv6 health checks are used to check the health of the backends. This field is applicable to either: - Advanced global external Application Load Balancer (load balancing scheme EXTERNAL_MANAGED), - Regional external Application Load Balancer, - Internal proxy Network Load Balancer (load balancing scheme INTERNAL_MANAGED), - Regional internal Application Load Balancer (load balancing scheme INTERNAL_MANAGED), - Traffic Director with Envoy proxies and proxyless gRPC (load balancing scheme INTERNAL_SELF_MANAGED). Check the IpAddressSelectionPolicy enum for the list of possible values.
optional string ip_address_selection_policy = 77600840;- Specified by:
getIpAddressSelectionPolicyBytesin interfaceBackendServiceOrBuilder- Returns:
- The bytes for ipAddressSelectionPolicy.
-
hasKind
public boolean hasKind()Output only. [Output Only] Type of resource. Always compute#backendService for backend services.
optional string kind = 3292052;- Specified by:
hasKindin interfaceBackendServiceOrBuilder- Returns:
- Whether the kind field is set.
-
getKind
Output only. [Output Only] Type of resource. Always compute#backendService for backend services.
optional string kind = 3292052;- Specified by:
getKindin interfaceBackendServiceOrBuilder- Returns:
- The kind.
-
getKindBytes
public com.google.protobuf.ByteString getKindBytes()Output only. [Output Only] Type of resource. Always compute#backendService for backend services.
optional string kind = 3292052;- Specified by:
getKindBytesin interfaceBackendServiceOrBuilder- Returns:
- The bytes for kind.
-
hasLoadBalancingScheme
public boolean hasLoadBalancingScheme()Specifies the load balancer type. A backend service created for one type of load balancer cannot be used with another. For more information, refer toChoosing a load balancer. Check the LoadBalancingScheme enum for the list of possible values.
optional string load_balancing_scheme = 363890244;- Specified by:
hasLoadBalancingSchemein interfaceBackendServiceOrBuilder- Returns:
- Whether the loadBalancingScheme field is set.
-
getLoadBalancingScheme
Specifies the load balancer type. A backend service created for one type of load balancer cannot be used with another. For more information, refer toChoosing a load balancer. Check the LoadBalancingScheme enum for the list of possible values.
optional string load_balancing_scheme = 363890244;- Specified by:
getLoadBalancingSchemein interfaceBackendServiceOrBuilder- Returns:
- The loadBalancingScheme.
-
getLoadBalancingSchemeBytes
public com.google.protobuf.ByteString getLoadBalancingSchemeBytes()Specifies the load balancer type. A backend service created for one type of load balancer cannot be used with another. For more information, refer toChoosing a load balancer. Check the LoadBalancingScheme enum for the list of possible values.
optional string load_balancing_scheme = 363890244;- Specified by:
getLoadBalancingSchemeBytesin interfaceBackendServiceOrBuilder- Returns:
- The bytes for loadBalancingScheme.
-
getLocalityLbPoliciesList
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, seeDefine a list of preferred policies. Caution: This field and its children are intended for use in a service mesh that includes gRPC clients only. Envoy proxies can't use backend services that have this configuration.
repeated .google.cloud.compute.v1.BackendServiceLocalityLoadBalancingPolicyConfig locality_lb_policies = 140982557;- Specified by:
getLocalityLbPoliciesListin interfaceBackendServiceOrBuilder
-
getLocalityLbPoliciesOrBuilderList
public List<? extends BackendServiceLocalityLoadBalancingPolicyConfigOrBuilder> getLocalityLbPoliciesOrBuilderList()A list of locality load-balancing policies to be used in order of preference. When you use localityLbPolicies, you must set at least one value for either the localityLbPolicies[].policy or the localityLbPolicies[].customPolicy field. localityLbPolicies overrides any value set in the localityLbPolicy field. For an example of how to use this field, seeDefine a list of preferred policies. Caution: This field and its children are intended for use in a service mesh that includes gRPC clients only. Envoy proxies can't use backend services that have this configuration.
repeated .google.cloud.compute.v1.BackendServiceLocalityLoadBalancingPolicyConfig locality_lb_policies = 140982557;- Specified by:
getLocalityLbPoliciesOrBuilderListin interfaceBackendServiceOrBuilder
-
getLocalityLbPoliciesCount
public int getLocalityLbPoliciesCount()A list of locality load-balancing policies to be used in order of preference. When you use localityLbPolicies, you must set at least one value for either the localityLbPolicies[].policy or the localityLbPolicies[].customPolicy field. localityLbPolicies overrides any value set in the localityLbPolicy field. For an example of how to use this field, seeDefine a list of preferred policies. Caution: This field and its children are intended for use in a service mesh that includes gRPC clients only. Envoy proxies can't use backend services that have this configuration.
repeated .google.cloud.compute.v1.BackendServiceLocalityLoadBalancingPolicyConfig locality_lb_policies = 140982557;- Specified by:
getLocalityLbPoliciesCountin interfaceBackendServiceOrBuilder
-
getLocalityLbPolicies
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, seeDefine a list of preferred policies. Caution: This field and its children are intended for use in a service mesh that includes gRPC clients only. Envoy proxies can't use backend services that have this configuration.
repeated .google.cloud.compute.v1.BackendServiceLocalityLoadBalancingPolicyConfig locality_lb_policies = 140982557;- Specified by:
getLocalityLbPoliciesin interfaceBackendServiceOrBuilder
-
getLocalityLbPoliciesOrBuilder
public BackendServiceLocalityLoadBalancingPolicyConfigOrBuilder getLocalityLbPoliciesOrBuilder(int index) A list of locality load-balancing policies to be used in order of preference. When you use localityLbPolicies, you must set at least one value for either the localityLbPolicies[].policy or the localityLbPolicies[].customPolicy field. localityLbPolicies overrides any value set in the localityLbPolicy field. For an example of how to use this field, seeDefine a list of preferred policies. Caution: This field and its children are intended for use in a service mesh that includes gRPC clients only. Envoy proxies can't use backend services that have this configuration.
repeated .google.cloud.compute.v1.BackendServiceLocalityLoadBalancingPolicyConfig locality_lb_policies = 140982557;- Specified by:
getLocalityLbPoliciesOrBuilderin interfaceBackendServiceOrBuilder
-
hasLocalityLbPolicy
public boolean hasLocalityLbPolicy()The load balancing algorithm used within the scope of the locality. The possible values are: - ROUND_ROBIN: This is a simple policy in which each healthy backend is selected in round robin order. This is the default. - LEAST_REQUEST: An O(1) algorithm which selects two random healthy hosts and picks the host which has fewer active requests. - RING_HASH: The ring/modulo hash load balancer implements consistent hashing to backends. The algorithm has the property that the addition/removal of a host from a set of N hosts only affects 1/N of the requests. - RANDOM: The load balancer selects a random healthy host. - ORIGINAL_DESTINATION: Backend host is selected based on the client connection metadata, i.e., connections are opened to the same address as the destination address of the incoming connection before the connection was redirected to the load balancer. - MAGLEV: used as a drop in replacement for the ring hash load balancer. Maglev is not as stable as ring hash but has faster table lookup build times and host selection times. For more information about Maglev, see Maglev: A Fast and Reliable Software Network Load Balancer. - WEIGHTED_ROUND_ROBIN: Per-endpoint Weighted Round Robin Load Balancing using weights computed from Backend reported Custom Metrics. If set, the Backend Service responses are expected to contain non-standard HTTP response header field Endpoint-Load-Metrics. The reported metrics to use for computing the weights are specified via thecustomMetrics field. This field is applicable to either: - A regional backend service with the service protocol set to HTTP, HTTPS, HTTP2 or H2C, and load_balancing_scheme set to INTERNAL_MANAGED. - A global backend service with the load_balancing_scheme set to INTERNAL_SELF_MANAGED, INTERNAL_MANAGED, or EXTERNAL_MANAGED. If sessionAffinity is not configured—that is, if session affinity remains at the default value of NONE—then the default value for localityLbPolicy is ROUND_ROBIN. If session affinity is set to a value other than NONE, then the default value for localityLbPolicy isMAGLEV. 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. localityLbPolicy cannot be specified with haPolicy. Check the LocalityLbPolicy enum for the list of possible values.
optional string locality_lb_policy = 131431487;- Specified by:
hasLocalityLbPolicyin interfaceBackendServiceOrBuilder- Returns:
- Whether the localityLbPolicy field is set.
-
getLocalityLbPolicy
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 Maglev: A Fast and Reliable Software Network Load Balancer. - WEIGHTED_ROUND_ROBIN: Per-endpoint Weighted Round Robin Load Balancing using weights computed from Backend reported Custom Metrics. If set, the Backend Service responses are expected to contain non-standard HTTP response header field Endpoint-Load-Metrics. The reported metrics to use for computing the weights are specified via thecustomMetrics field. This field is applicable to either: - A regional backend service with the service protocol set to HTTP, HTTPS, HTTP2 or H2C, and load_balancing_scheme set to INTERNAL_MANAGED. - A global backend service with the load_balancing_scheme set to INTERNAL_SELF_MANAGED, INTERNAL_MANAGED, or EXTERNAL_MANAGED. If sessionAffinity is not configured—that is, if session affinity remains at the default value of NONE—then the default value for localityLbPolicy is ROUND_ROBIN. If session affinity is set to a value other than NONE, then the default value for localityLbPolicy isMAGLEV. 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. localityLbPolicy cannot be specified with haPolicy. Check the LocalityLbPolicy enum for the list of possible values.
optional string locality_lb_policy = 131431487;- Specified by:
getLocalityLbPolicyin interfaceBackendServiceOrBuilder- Returns:
- The localityLbPolicy.
-
getLocalityLbPolicyBytes
public com.google.protobuf.ByteString getLocalityLbPolicyBytes()The load balancing algorithm used within the scope of the locality. The possible values are: - ROUND_ROBIN: This is a simple policy in which each healthy backend is selected in round robin order. This is the default. - LEAST_REQUEST: An O(1) algorithm which selects two random healthy hosts and picks the host which has fewer active requests. - RING_HASH: The ring/modulo hash load balancer implements consistent hashing to backends. The algorithm has the property that the addition/removal of a host from a set of N hosts only affects 1/N of the requests. - RANDOM: The load balancer selects a random healthy host. - ORIGINAL_DESTINATION: Backend host is selected based on the client connection metadata, i.e., connections are opened to the same address as the destination address of the incoming connection before the connection was redirected to the load balancer. - MAGLEV: used as a drop in replacement for the ring hash load balancer. Maglev is not as stable as ring hash but has faster table lookup build times and host selection times. For more information about Maglev, see Maglev: A Fast and Reliable Software Network Load Balancer. - WEIGHTED_ROUND_ROBIN: Per-endpoint Weighted Round Robin Load Balancing using weights computed from Backend reported Custom Metrics. If set, the Backend Service responses are expected to contain non-standard HTTP response header field Endpoint-Load-Metrics. The reported metrics to use for computing the weights are specified via thecustomMetrics field. This field is applicable to either: - A regional backend service with the service protocol set to HTTP, HTTPS, HTTP2 or H2C, and load_balancing_scheme set to INTERNAL_MANAGED. - A global backend service with the load_balancing_scheme set to INTERNAL_SELF_MANAGED, INTERNAL_MANAGED, or EXTERNAL_MANAGED. If sessionAffinity is not configured—that is, if session affinity remains at the default value of NONE—then the default value for localityLbPolicy is ROUND_ROBIN. If session affinity is set to a value other than NONE, then the default value for localityLbPolicy isMAGLEV. 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. localityLbPolicy cannot be specified with haPolicy. Check the LocalityLbPolicy enum for the list of possible values.
optional string locality_lb_policy = 131431487;- Specified by:
getLocalityLbPolicyBytesin interfaceBackendServiceOrBuilder- Returns:
- The bytes for localityLbPolicy.
-
hasLogConfig
public boolean hasLogConfig()This field denotes the logging options for the load balancer traffic served by this backend service. If logging is enabled, logs will be exported to Stackdriver.
optional .google.cloud.compute.v1.BackendServiceLogConfig log_config = 351299741;- Specified by:
hasLogConfigin interfaceBackendServiceOrBuilder- Returns:
- Whether the logConfig field is set.
-
getLogConfig
This field denotes the logging options for the load balancer traffic served by this backend service. If logging is enabled, logs will be exported to Stackdriver.
optional .google.cloud.compute.v1.BackendServiceLogConfig log_config = 351299741;- Specified by:
getLogConfigin interfaceBackendServiceOrBuilder- Returns:
- The logConfig.
-
getLogConfigOrBuilder
This field denotes the logging options for the load balancer traffic served by this backend service. If logging is enabled, logs will be exported to Stackdriver.
optional .google.cloud.compute.v1.BackendServiceLogConfig log_config = 351299741;- Specified by:
getLogConfigOrBuilderin interfaceBackendServiceOrBuilder
-
hasMaxStreamDuration
public boolean hasMaxStreamDuration()Specifies the default maximum duration (timeout) for streams to this service. Duration is computed from the beginning of the stream until the response has been completely processed, including all retries. A stream that does not complete in this duration is closed. If not specified, there will be no timeout limit, i.e. the maximum duration is infinite. This value can be overridden in the PathMatcher configuration of the UrlMap that references this backend service. This field is only allowed when the loadBalancingScheme of the backend service is INTERNAL_SELF_MANAGED.
optional .google.cloud.compute.v1.Duration max_stream_duration = 61428376;- Specified by:
hasMaxStreamDurationin interfaceBackendServiceOrBuilder- Returns:
- Whether the maxStreamDuration field is set.
-
getMaxStreamDuration
Specifies the default maximum duration (timeout) for streams to this service. Duration is computed from the beginning of the stream until the response has been completely processed, including all retries. A stream that does not complete in this duration is closed. If not specified, there will be no timeout limit, i.e. the maximum duration is infinite. This value can be overridden in the PathMatcher configuration of the UrlMap that references this backend service. This field is only allowed when the loadBalancingScheme of the backend service is INTERNAL_SELF_MANAGED.
optional .google.cloud.compute.v1.Duration max_stream_duration = 61428376;- Specified by:
getMaxStreamDurationin interfaceBackendServiceOrBuilder- Returns:
- The maxStreamDuration.
-
getMaxStreamDurationOrBuilder
Specifies the default maximum duration (timeout) for streams to this service. Duration is computed from the beginning of the stream until the response has been completely processed, including all retries. A stream that does not complete in this duration is closed. If not specified, there will be no timeout limit, i.e. the maximum duration is infinite. This value can be overridden in the PathMatcher configuration of the UrlMap that references this backend service. This field is only allowed when the loadBalancingScheme of the backend service is INTERNAL_SELF_MANAGED.
optional .google.cloud.compute.v1.Duration max_stream_duration = 61428376;- Specified by:
getMaxStreamDurationOrBuilderin interfaceBackendServiceOrBuilder
-
getMetadatasCount
public int getMetadatasCount()Description copied from interface:BackendServiceOrBuilderDeployment metadata associated with the resource to be set by a GKE hub controller and read by the backend RCTH
map<string, string> metadatas = 8514340;- Specified by:
getMetadatasCountin interfaceBackendServiceOrBuilder
-
containsMetadatas
Deployment metadata associated with the resource to be set by a GKE hub controller and read by the backend RCTH
map<string, string> metadatas = 8514340;- Specified by:
containsMetadatasin interfaceBackendServiceOrBuilder
-
getMetadatas
Deprecated.UsegetMetadatasMap()instead.- Specified by:
getMetadatasin interfaceBackendServiceOrBuilder
-
getMetadatasMap
Deployment metadata associated with the resource to be set by a GKE hub controller and read by the backend RCTH
map<string, string> metadatas = 8514340;- Specified by:
getMetadatasMapin interfaceBackendServiceOrBuilder
-
getMetadatasOrDefault
Deployment metadata associated with the resource to be set by a GKE hub controller and read by the backend RCTH
map<string, string> metadatas = 8514340;- Specified by:
getMetadatasOrDefaultin interfaceBackendServiceOrBuilder
-
getMetadatasOrThrow
Deployment metadata associated with the resource to be set by a GKE hub controller and read by the backend RCTH
map<string, string> metadatas = 8514340;- Specified by:
getMetadatasOrThrowin interfaceBackendServiceOrBuilder
-
hasName
public boolean hasName()Name of the resource. Provided by the client when the resource is created. The name must be 1-63 characters long, and comply withRFC1035. Specifically, the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.
optional string name = 3373707;- Specified by:
hasNamein interfaceBackendServiceOrBuilder- Returns:
- Whether the name field is set.
-
getName
Name of the resource. Provided by the client when the resource is created. The name must be 1-63 characters long, and comply withRFC1035. Specifically, the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.
optional string name = 3373707;- Specified by:
getNamein interfaceBackendServiceOrBuilder- Returns:
- The name.
-
getNameBytes
public com.google.protobuf.ByteString getNameBytes()Name of the resource. Provided by the client when the resource is created. The name must be 1-63 characters long, and comply withRFC1035. Specifically, the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.
optional string name = 3373707;- Specified by:
getNameBytesin interfaceBackendServiceOrBuilder- Returns:
- The bytes for name.
-
hasNetwork
public boolean hasNetwork()The URL of the network to which this backend service belongs. This field must be set for Internal Passthrough Network Load Balancers when the haPolicy is enabled, and for External Passthrough Network Load Balancers when the haPolicy fastIpMove is enabled. This field can only be specified when the load balancing scheme is set toINTERNAL, or when the load balancing scheme is set toEXTERNAL and haPolicy fastIpMove is enabled.
optional string network = 232872494;- Specified by:
hasNetworkin interfaceBackendServiceOrBuilder- Returns:
- Whether the network field is set.
-
getNetwork
The URL of the network to which this backend service belongs. This field must be set for Internal Passthrough Network Load Balancers when the haPolicy is enabled, and for External Passthrough Network Load Balancers when the haPolicy fastIpMove is enabled. This field can only be specified when the load balancing scheme is set toINTERNAL, or when the load balancing scheme is set toEXTERNAL and haPolicy fastIpMove is enabled.
optional string network = 232872494;- Specified by:
getNetworkin interfaceBackendServiceOrBuilder- Returns:
- The network.
-
getNetworkBytes
public com.google.protobuf.ByteString getNetworkBytes()The URL of the network to which this backend service belongs. This field must be set for Internal Passthrough Network Load Balancers when the haPolicy is enabled, and for External Passthrough Network Load Balancers when the haPolicy fastIpMove is enabled. This field can only be specified when the load balancing scheme is set toINTERNAL, or when the load balancing scheme is set toEXTERNAL and haPolicy fastIpMove is enabled.
optional string network = 232872494;- Specified by:
getNetworkBytesin interfaceBackendServiceOrBuilder- Returns:
- The bytes for network.
-
hasNetworkPassThroughLbTrafficPolicy
public boolean hasNetworkPassThroughLbTrafficPolicy()Configures traffic steering properties of internal passthrough Network Load Balancers. networkPassThroughLbTrafficPolicy cannot be specified with haPolicy.
optional .google.cloud.compute.v1.BackendServiceNetworkPassThroughLbTrafficPolicy network_pass_through_lb_traffic_policy = 230323750;- Specified by:
hasNetworkPassThroughLbTrafficPolicyin interfaceBackendServiceOrBuilder- Returns:
- Whether the networkPassThroughLbTrafficPolicy field is set.
-
getNetworkPassThroughLbTrafficPolicy
Configures traffic steering properties of internal passthrough Network Load Balancers. networkPassThroughLbTrafficPolicy cannot be specified with haPolicy.
optional .google.cloud.compute.v1.BackendServiceNetworkPassThroughLbTrafficPolicy network_pass_through_lb_traffic_policy = 230323750;- Specified by:
getNetworkPassThroughLbTrafficPolicyin interfaceBackendServiceOrBuilder- Returns:
- The networkPassThroughLbTrafficPolicy.
-
getNetworkPassThroughLbTrafficPolicyOrBuilder
public BackendServiceNetworkPassThroughLbTrafficPolicyOrBuilder getNetworkPassThroughLbTrafficPolicyOrBuilder()Configures traffic steering properties of internal passthrough Network Load Balancers. networkPassThroughLbTrafficPolicy cannot be specified with haPolicy.
optional .google.cloud.compute.v1.BackendServiceNetworkPassThroughLbTrafficPolicy network_pass_through_lb_traffic_policy = 230323750;- Specified by:
getNetworkPassThroughLbTrafficPolicyOrBuilderin interfaceBackendServiceOrBuilder
-
hasOrchestrationInfo
public boolean hasOrchestrationInfo()Information about the resource or system that manages the backend service.
optional .google.cloud.compute.v1.BackendServiceOrchestrationInfo orchestration_info = 441144300;- Specified by:
hasOrchestrationInfoin interfaceBackendServiceOrBuilder- Returns:
- Whether the orchestrationInfo field is set.
-
getOrchestrationInfo
Information about the resource or system that manages the backend service.
optional .google.cloud.compute.v1.BackendServiceOrchestrationInfo orchestration_info = 441144300;- Specified by:
getOrchestrationInfoin interfaceBackendServiceOrBuilder- Returns:
- The orchestrationInfo.
-
getOrchestrationInfoOrBuilder
Information about the resource or system that manages the backend service.
optional .google.cloud.compute.v1.BackendServiceOrchestrationInfo orchestration_info = 441144300;- Specified by:
getOrchestrationInfoOrBuilderin interfaceBackendServiceOrBuilder
-
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 service protocol set to HTTP, HTTPS, HTTP2 or H2C, and loadBalancingScheme set to INTERNAL_MANAGED or EXTERNAL_MANAGED. Not supported for Serverless NEGs. Not supported when the backend service is referenced by a URL map that is bound to target gRPC proxy that has validateForProxyless field set to true.
optional .google.cloud.compute.v1.OutlierDetection outlier_detection = 354625086;- Specified by:
hasOutlierDetectionin interfaceBackendServiceOrBuilder- Returns:
- Whether the outlierDetection field is set.
-
getOutlierDetection
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 service protocol set to HTTP, HTTPS, HTTP2 or H2C, and loadBalancingScheme set to INTERNAL_MANAGED or EXTERNAL_MANAGED. Not supported for Serverless NEGs. Not supported when the backend service is referenced by a URL map that is bound to target gRPC proxy that has validateForProxyless field set to true.
optional .google.cloud.compute.v1.OutlierDetection outlier_detection = 354625086;- Specified by:
getOutlierDetectionin interfaceBackendServiceOrBuilder- Returns:
- The outlierDetection.
-
getOutlierDetectionOrBuilder
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 service protocol set to HTTP, HTTPS, HTTP2 or H2C, and loadBalancingScheme set to INTERNAL_MANAGED or EXTERNAL_MANAGED. Not supported for Serverless NEGs. Not supported when the backend service is referenced by a URL map that is bound to target gRPC proxy that has validateForProxyless field set to true.
optional .google.cloud.compute.v1.OutlierDetection outlier_detection = 354625086;- Specified by:
getOutlierDetectionOrBuilderin interfaceBackendServiceOrBuilder
-
hasParams
public boolean hasParams()Input only. [Input Only] Additional params passed with the request, but not persisted as part of resource payload.
optional .google.cloud.compute.v1.BackendServiceParams params = 78313862;- Specified by:
hasParamsin interfaceBackendServiceOrBuilder- Returns:
- Whether the params field is set.
-
getParams
Input only. [Input Only] Additional params passed with the request, but not persisted as part of resource payload.
optional .google.cloud.compute.v1.BackendServiceParams params = 78313862;- Specified by:
getParamsin interfaceBackendServiceOrBuilder- Returns:
- The params.
-
getParamsOrBuilder
Input only. [Input Only] Additional params passed with the request, but not persisted as part of resource payload.
optional .google.cloud.compute.v1.BackendServiceParams params = 78313862;- Specified by:
getParamsOrBuilderin 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 passthrough Network Load Balancers and external passthrough Network Load Balancers, omit port.
optional int32 port = 3446913;- Specified by:
hasPortin interfaceBackendServiceOrBuilder- Returns:
- Whether the port field is set.
-
getPort
public int getPort()Deprecated in favor of portName. The TCP port to connect on the backend. The default value is 80. For internal passthrough Network Load Balancers and external passthrough Network Load Balancers, omit port.
optional int32 port = 3446913;- Specified by:
getPortin interfaceBackendServiceOrBuilder- Returns:
- The port.
-
hasPortName
public boolean hasPortName()A named port on a backend instance group representing the port for communication to the backend VMs in that group. The named port must be [defined on each backend instance group](https://cloud.google.com/load-balancing/docs/backend-service#named_ports). This parameter has no meaning if the backends are NEGs. For internal passthrough Network Load Balancers and external passthrough Network Load Balancers, omit port_name.
optional string port_name = 41534345;- Specified by:
hasPortNamein interfaceBackendServiceOrBuilder- Returns:
- Whether the portName field is set.
-
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 passthrough Network Load Balancers and external passthrough Network Load Balancers, omit port_name.
optional string port_name = 41534345;- Specified by:
getPortNamein interfaceBackendServiceOrBuilder- Returns:
- The portName.
-
getPortNameBytes
public com.google.protobuf.ByteString getPortNameBytes()A named port on a backend instance group representing the port for communication to the backend VMs in that group. The named port must be [defined on each backend instance group](https://cloud.google.com/load-balancing/docs/backend-service#named_ports). This parameter has no meaning if the backends are NEGs. For internal passthrough Network Load Balancers and external passthrough Network Load Balancers, omit port_name.
optional string port_name = 41534345;- Specified by:
getPortNameBytesin interfaceBackendServiceOrBuilder- Returns:
- The bytes for portName.
-
hasProtocol
public boolean hasProtocol()The protocol this BackendService uses to communicate with backends. Possible values are HTTP, HTTPS, HTTP2, H2C, TCP, SSL, UDP or GRPC. depending on the chosen load balancer or Traffic Director configuration. Refer to the documentation for the load balancers or for Traffic Director for more information. Must be set to GRPC when the backend service is referenced by a URL map that is bound to target gRPC proxy. Check the Protocol enum for the list of possible values.
optional string protocol = 84577944;- Specified by:
hasProtocolin interfaceBackendServiceOrBuilder- Returns:
- Whether the protocol field is set.
-
getProtocol
The protocol this BackendService uses to communicate with backends. Possible values are HTTP, HTTPS, HTTP2, H2C, TCP, SSL, UDP or GRPC. depending on the chosen load balancer or Traffic Director configuration. Refer to the documentation for the load balancers or for Traffic Director for more information. Must be set to GRPC when the backend service is referenced by a URL map that is bound to target gRPC proxy. Check the Protocol enum for the list of possible values.
optional string protocol = 84577944;- Specified by:
getProtocolin interfaceBackendServiceOrBuilder- Returns:
- The protocol.
-
getProtocolBytes
public com.google.protobuf.ByteString getProtocolBytes()The protocol this BackendService uses to communicate with backends. Possible values are HTTP, HTTPS, HTTP2, H2C, TCP, SSL, UDP or GRPC. depending on the chosen load balancer or Traffic Director configuration. Refer to the documentation for the load balancers or for Traffic Director for more information. Must be set to GRPC when the backend service is referenced by a URL map that is bound to target gRPC proxy. Check the Protocol enum for the list of possible values.
optional string protocol = 84577944;- Specified by:
getProtocolBytesin interfaceBackendServiceOrBuilder- Returns:
- The bytes for protocol.
-
hasRegion
public boolean hasRegion()Output only. [Output Only] URL of the region where the regional backend service resides. This field is not applicable to global backend services. You must specify this field as part of the HTTP request URL. It is not settable as a field in the request body.
optional string region = 138946292;- Specified by:
hasRegionin interfaceBackendServiceOrBuilder- Returns:
- Whether the region field is set.
-
getRegion
Output only. [Output Only] URL of the region where the regional backend service resides. This field is not applicable to global backend services. You must specify this field as part of the HTTP request URL. It is not settable as a field in the request body.
optional string region = 138946292;- Specified by:
getRegionin interfaceBackendServiceOrBuilder- Returns:
- The region.
-
getRegionBytes
public com.google.protobuf.ByteString getRegionBytes()Output only. [Output Only] URL of the region where the regional backend service resides. This field is not applicable to global backend services. You must specify this field as part of the HTTP request URL. It is not settable as a field in the request body.
optional string region = 138946292;- Specified by:
getRegionBytesin interfaceBackendServiceOrBuilder- Returns:
- The bytes for region.
-
hasSecurityPolicy
public boolean hasSecurityPolicy()[Output Only] The resource URL for the security policy associated with this backend service.
optional string security_policy = 171082513;- Specified by:
hasSecurityPolicyin interfaceBackendServiceOrBuilder- Returns:
- Whether the securityPolicy field is set.
-
getSecurityPolicy
[Output Only] The resource URL for the security policy associated with this backend service.
optional string security_policy = 171082513;- Specified by:
getSecurityPolicyin interfaceBackendServiceOrBuilder- Returns:
- The securityPolicy.
-
getSecurityPolicyBytes
public com.google.protobuf.ByteString getSecurityPolicyBytes()[Output Only] The resource URL for the security policy associated with this backend service.
optional string security_policy = 171082513;- Specified by:
getSecurityPolicyBytesin interfaceBackendServiceOrBuilder- Returns:
- The bytes for securityPolicy.
-
hasSecuritySettings
public boolean hasSecuritySettings()This field specifies the security settings that apply to this backend service. This field is applicable to a global backend service with the load_balancing_scheme set to INTERNAL_SELF_MANAGED.
optional .google.cloud.compute.v1.SecuritySettings security_settings = 478649922;- Specified by:
hasSecuritySettingsin interfaceBackendServiceOrBuilder- Returns:
- Whether the securitySettings field is set.
-
getSecuritySettings
This field specifies the security settings that apply to this backend service. This field is applicable to a global backend service with the load_balancing_scheme set to INTERNAL_SELF_MANAGED.
optional .google.cloud.compute.v1.SecuritySettings security_settings = 478649922;- Specified by:
getSecuritySettingsin interfaceBackendServiceOrBuilder- Returns:
- The securitySettings.
-
getSecuritySettingsOrBuilder
This field specifies the security settings that apply to this backend service. This field is applicable to a global backend service with the load_balancing_scheme set to INTERNAL_SELF_MANAGED.
optional .google.cloud.compute.v1.SecuritySettings security_settings = 478649922;- Specified by:
getSecuritySettingsOrBuilderin interfaceBackendServiceOrBuilder
-
hasSelfLink
public boolean hasSelfLink()[Output Only] Server-defined URL for the resource.
optional string self_link = 456214797;- Specified by:
hasSelfLinkin interfaceBackendServiceOrBuilder- Returns:
- Whether the selfLink field is set.
-
getSelfLink
[Output Only] Server-defined URL for the resource.
optional string self_link = 456214797;- Specified by:
getSelfLinkin interfaceBackendServiceOrBuilder- Returns:
- The selfLink.
-
getSelfLinkBytes
public com.google.protobuf.ByteString getSelfLinkBytes()[Output Only] Server-defined URL for the resource.
optional string self_link = 456214797;- Specified by:
getSelfLinkBytesin interfaceBackendServiceOrBuilder- Returns:
- The bytes for selfLink.
-
getServiceBindingsList
public com.google.protobuf.ProtocolStringList getServiceBindingsList()URLs of networkservices.ServiceBinding resources. Can only be set if load balancing scheme is INTERNAL_SELF_MANAGED. If set, lists of backends and health checks must be both empty.
repeated string service_bindings = 133581016;- Specified by:
getServiceBindingsListin interfaceBackendServiceOrBuilder- Returns:
- A list containing the serviceBindings.
-
getServiceBindingsCount
public int getServiceBindingsCount()URLs of networkservices.ServiceBinding resources. Can only be set if load balancing scheme is INTERNAL_SELF_MANAGED. If set, lists of backends and health checks must be both empty.
repeated string service_bindings = 133581016;- Specified by:
getServiceBindingsCountin interfaceBackendServiceOrBuilder- Returns:
- The count of serviceBindings.
-
getServiceBindings
URLs of networkservices.ServiceBinding resources. Can only be set if load balancing scheme is INTERNAL_SELF_MANAGED. If set, lists of backends and health checks must be both empty.
repeated string service_bindings = 133581016;- Specified by:
getServiceBindingsin interfaceBackendServiceOrBuilder- Parameters:
index- The index of the element to return.- Returns:
- The serviceBindings at the given index.
-
getServiceBindingsBytes
public com.google.protobuf.ByteString getServiceBindingsBytes(int index) URLs of networkservices.ServiceBinding resources. Can only be set if load balancing scheme is INTERNAL_SELF_MANAGED. If set, lists of backends and health checks must be both empty.
repeated string service_bindings = 133581016;- Specified by:
getServiceBindingsBytesin interfaceBackendServiceOrBuilder- Parameters:
index- The index of the value to return.- Returns:
- The bytes of the serviceBindings at the given index.
-
hasServiceLbPolicy
public boolean hasServiceLbPolicy()URL to networkservices.ServiceLbPolicy resource. Can only be set if load balancing scheme is EXTERNAL_MANAGED, INTERNAL_MANAGED or INTERNAL_SELF_MANAGED and the scope is global.
optional string service_lb_policy = 94848785;- Specified by:
hasServiceLbPolicyin interfaceBackendServiceOrBuilder- Returns:
- Whether the serviceLbPolicy field is set.
-
getServiceLbPolicy
URL to networkservices.ServiceLbPolicy resource. Can only be set if load balancing scheme is EXTERNAL_MANAGED, INTERNAL_MANAGED or INTERNAL_SELF_MANAGED and the scope is global.
optional string service_lb_policy = 94848785;- Specified by:
getServiceLbPolicyin interfaceBackendServiceOrBuilder- Returns:
- The serviceLbPolicy.
-
getServiceLbPolicyBytes
public com.google.protobuf.ByteString getServiceLbPolicyBytes()URL to networkservices.ServiceLbPolicy resource. Can only be set if load balancing scheme is EXTERNAL_MANAGED, INTERNAL_MANAGED or INTERNAL_SELF_MANAGED and the scope is global.
optional string service_lb_policy = 94848785;- Specified by:
getServiceLbPolicyBytesin interfaceBackendServiceOrBuilder- Returns:
- The bytes for serviceLbPolicy.
-
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). sessionAffinity cannot be specified with haPolicy. Check the SessionAffinity enum for the list of possible values.
optional string session_affinity = 463888561;- Specified by:
hasSessionAffinityin interfaceBackendServiceOrBuilder- Returns:
- Whether the sessionAffinity field is set.
-
getSessionAffinity
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). sessionAffinity cannot be specified with haPolicy. Check the SessionAffinity enum for the list of possible values.
optional string session_affinity = 463888561;- Specified by:
getSessionAffinityin interfaceBackendServiceOrBuilder- Returns:
- The sessionAffinity.
-
getSessionAffinityBytes
public com.google.protobuf.ByteString getSessionAffinityBytes()Type of session affinity to use. The default is NONE. Only NONE and HEADER_FIELD are supported when the backend service is referenced by a URL map that is bound to target gRPC proxy that has validateForProxyless field set to true. For more details, see: [Session Affinity](https://cloud.google.com/load-balancing/docs/backend-service#session_affinity). sessionAffinity cannot be specified with haPolicy. Check the SessionAffinity enum for the list of possible values.
optional string session_affinity = 463888561;- Specified by:
getSessionAffinityBytesin interfaceBackendServiceOrBuilder- Returns:
- The bytes for sessionAffinity.
-
hasStrongSessionAffinityCookie
public boolean hasStrongSessionAffinityCookie()Describes the HTTP cookie used for stateful session affinity. This field is applicable and required if the sessionAffinity is set toSTRONG_COOKIE_AFFINITY.
optional .google.cloud.compute.v1.BackendServiceHttpCookie strong_session_affinity_cookie = 238195722;- Specified by:
hasStrongSessionAffinityCookiein interfaceBackendServiceOrBuilder- Returns:
- Whether the strongSessionAffinityCookie field is set.
-
getStrongSessionAffinityCookie
Describes the HTTP cookie used for stateful session affinity. This field is applicable and required if the sessionAffinity is set toSTRONG_COOKIE_AFFINITY.
optional .google.cloud.compute.v1.BackendServiceHttpCookie strong_session_affinity_cookie = 238195722;- Specified by:
getStrongSessionAffinityCookiein interfaceBackendServiceOrBuilder- Returns:
- The strongSessionAffinityCookie.
-
getStrongSessionAffinityCookieOrBuilder
Describes the HTTP cookie used for stateful session affinity. This field is applicable and required if the sessionAffinity is set toSTRONG_COOKIE_AFFINITY.
optional .google.cloud.compute.v1.BackendServiceHttpCookie strong_session_affinity_cookie = 238195722;- Specified by:
getStrongSessionAffinityCookieOrBuilderin interfaceBackendServiceOrBuilder
-
hasSubsetting
public boolean hasSubsetting()subsetting cannot be specified with haPolicy.
optional .google.cloud.compute.v1.Subsetting subsetting = 450283536;- Specified by:
hasSubsettingin interfaceBackendServiceOrBuilder- Returns:
- Whether the subsetting field is set.
-
getSubsetting
subsetting cannot be specified with haPolicy.
optional .google.cloud.compute.v1.Subsetting subsetting = 450283536;- Specified by:
getSubsettingin interfaceBackendServiceOrBuilder- Returns:
- The subsetting.
-
getSubsettingOrBuilder
subsetting cannot be specified with haPolicy.
optional .google.cloud.compute.v1.Subsetting subsetting = 450283536;- Specified by:
getSubsettingOrBuilderin interfaceBackendServiceOrBuilder
-
hasTimeoutSec
public boolean hasTimeoutSec()The backend service timeout has a different meaning depending on the type of load balancer. For more information see, Backend service settings. The default is 30 seconds. The full range of timeout values allowed goes from 1 through 2,147,483,647 seconds. This value can be overridden in the PathMatcher configuration of the UrlMap that references this backend service. Not supported when the backend service is referenced by a URL map that is bound to target gRPC proxy that has validateForProxyless field set to true. Instead, use maxStreamDuration.
optional int32 timeout_sec = 79994995;- Specified by:
hasTimeoutSecin interfaceBackendServiceOrBuilder- Returns:
- Whether the timeoutSec field is set.
-
getTimeoutSec
public int getTimeoutSec()The backend service timeout has a different meaning depending on the type of load balancer. For more information see, Backend service settings. The default is 30 seconds. The full range of timeout values allowed goes from 1 through 2,147,483,647 seconds. This value can be overridden in the PathMatcher configuration of the UrlMap that references this backend service. Not supported when the backend service is referenced by a URL map that is bound to target gRPC proxy that has validateForProxyless field set to true. Instead, use maxStreamDuration.
optional int32 timeout_sec = 79994995;- Specified by:
getTimeoutSecin interfaceBackendServiceOrBuilder- Returns:
- The timeoutSec.
-
hasTlsSettings
public boolean hasTlsSettings()Configuration for Backend Authenticated TLS and mTLS. May only be specified when the backend protocol is SSL, HTTPS or HTTP2.
optional .google.cloud.compute.v1.BackendServiceTlsSettings tls_settings = 81794791;- Specified by:
hasTlsSettingsin interfaceBackendServiceOrBuilder- Returns:
- Whether the tlsSettings field is set.
-
getTlsSettings
Configuration for Backend Authenticated TLS and mTLS. May only be specified when the backend protocol is SSL, HTTPS or HTTP2.
optional .google.cloud.compute.v1.BackendServiceTlsSettings tls_settings = 81794791;- Specified by:
getTlsSettingsin interfaceBackendServiceOrBuilder- Returns:
- The tlsSettings.
-
getTlsSettingsOrBuilder
Configuration for Backend Authenticated TLS and mTLS. May only be specified when the backend protocol is SSL, HTTPS or HTTP2.
optional .google.cloud.compute.v1.BackendServiceTlsSettings tls_settings = 81794791;- Specified by:
getTlsSettingsOrBuilderin interfaceBackendServiceOrBuilder
-
getUsedByList
Output only. [Output Only] List of resources referencing given backend service.
repeated .google.cloud.compute.v1.BackendServiceUsedBy used_by = 389320729;- Specified by:
getUsedByListin interfaceBackendServiceOrBuilder
-
getUsedByOrBuilderList
Output only. [Output Only] List of resources referencing given backend service.
repeated .google.cloud.compute.v1.BackendServiceUsedBy used_by = 389320729;- Specified by:
getUsedByOrBuilderListin interfaceBackendServiceOrBuilder
-
getUsedByCount
public int getUsedByCount()Output only. [Output Only] List of resources referencing given backend service.
repeated .google.cloud.compute.v1.BackendServiceUsedBy used_by = 389320729;- Specified by:
getUsedByCountin interfaceBackendServiceOrBuilder
-
getUsedBy
Output only. [Output Only] List of resources referencing given backend service.
repeated .google.cloud.compute.v1.BackendServiceUsedBy used_by = 389320729;- Specified by:
getUsedByin interfaceBackendServiceOrBuilder
-
getUsedByOrBuilder
Output only. [Output Only] List of resources referencing given backend service.
repeated .google.cloud.compute.v1.BackendServiceUsedBy used_by = 389320729;- Specified by:
getUsedByOrBuilderin interfaceBackendServiceOrBuilder
-
isInitialized
public final boolean isInitialized()- Specified by:
isInitializedin interfacecom.google.protobuf.MessageLiteOrBuilder- Overrides:
isInitializedin classcom.google.protobuf.GeneratedMessage
-
writeTo
- Specified by:
writeToin interfacecom.google.protobuf.MessageLite- Overrides:
writeToin classcom.google.protobuf.GeneratedMessage- Throws:
IOException
-
getSerializedSize
public int getSerializedSize()- Specified by:
getSerializedSizein interfacecom.google.protobuf.MessageLite- Overrides:
getSerializedSizein classcom.google.protobuf.GeneratedMessage
-
equals
- Specified by:
equalsin interfacecom.google.protobuf.Message- Overrides:
equalsin classcom.google.protobuf.AbstractMessage
-
hashCode
public int hashCode()- Specified by:
hashCodein interfacecom.google.protobuf.Message- Overrides:
hashCodein classcom.google.protobuf.AbstractMessage
-
parseFrom
public static BackendService parseFrom(ByteBuffer data) throws com.google.protobuf.InvalidProtocolBufferException - Throws:
com.google.protobuf.InvalidProtocolBufferException
-
parseFrom
public static BackendService parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException - Throws:
com.google.protobuf.InvalidProtocolBufferException
-
parseFrom
public static BackendService parseFrom(com.google.protobuf.ByteString data) throws com.google.protobuf.InvalidProtocolBufferException - Throws:
com.google.protobuf.InvalidProtocolBufferException
-
parseFrom
public static BackendService parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException - Throws:
com.google.protobuf.InvalidProtocolBufferException
-
parseFrom
public static BackendService parseFrom(byte[] data) throws com.google.protobuf.InvalidProtocolBufferException - Throws:
com.google.protobuf.InvalidProtocolBufferException
-
parseFrom
public static BackendService parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException - Throws:
com.google.protobuf.InvalidProtocolBufferException
-
parseFrom
- Throws:
IOException
-
parseFrom
public static BackendService parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException - Throws:
IOException
-
parseDelimitedFrom
- 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
- Specified by:
newBuilderForTypein interfacecom.google.protobuf.Message- Specified by:
newBuilderForTypein interfacecom.google.protobuf.MessageLite
-
newBuilder
-
newBuilder
-
toBuilder
- Specified by:
toBuilderin interfacecom.google.protobuf.Message- Specified by:
toBuilderin interfacecom.google.protobuf.MessageLite
-
newBuilderForType
protected BackendService.Builder newBuilderForType(com.google.protobuf.AbstractMessage.BuilderParent parent) - Overrides:
newBuilderForTypein classcom.google.protobuf.AbstractMessage
-
getDefaultInstance
-
parser
-
getParserForType
- Specified by:
getParserForTypein interfacecom.google.protobuf.Message- Specified by:
getParserForTypein interfacecom.google.protobuf.MessageLite- Overrides:
getParserForTypein classcom.google.protobuf.GeneratedMessage
-
getDefaultInstanceForType
- Specified by:
getDefaultInstanceForTypein interfacecom.google.protobuf.MessageLiteOrBuilder- Specified by:
getDefaultInstanceForTypein interfacecom.google.protobuf.MessageOrBuilder
-