BackendService

google.cloud.compute.v1. BackendService

Represents a BackendService.

Constructor

new BackendService(propertiesopt)

Constructs a new BackendService.

Parameters:
Name Type Attributes Description
properties google.cloud.compute.v1.IBackendService <optional>

Properties to set
Implements:
  • IBackendService

Members

_affinityCookieTtlSec

BackendService _affinityCookieTtlSec.

_cdnPolicy

BackendService _cdnPolicy.

_circuitBreakers

BackendService _circuitBreakers.

_compressionMode

BackendService _compressionMode.

_connectionDraining

BackendService _connectionDraining.

_connectionTrackingPolicy

BackendService _connectionTrackingPolicy.

_consistentHash

BackendService _consistentHash.

_creationTimestamp

BackendService _creationTimestamp.

_description

BackendService _description.

_edgeSecurityPolicy

BackendService _edgeSecurityPolicy.

_enableCDN

BackendService _enableCDN.

_failoverPolicy

BackendService _failoverPolicy.

_fingerprint

BackendService _fingerprint.

_iap

BackendService _iap.

_id

BackendService _id.

_kind

BackendService _kind.

_loadBalancingScheme

BackendService _loadBalancingScheme.

_localityLbPolicy

BackendService _localityLbPolicy.

_logConfig

BackendService _logConfig.

_maxStreamDuration

BackendService _maxStreamDuration.

_name

BackendService _name.

_network

BackendService _network.

_outlierDetection

BackendService _outlierDetection.

_port

BackendService _port.

_portName

BackendService _portName.

_protocol

BackendService _protocol.

_region

BackendService _region.

_securityPolicy

BackendService _securityPolicy.

_securitySettings

BackendService _securitySettings.

_selfLink

BackendService _selfLink.

_sessionAffinity

BackendService _sessionAffinity.

_subsetting

BackendService _subsetting.

_timeoutSec

BackendService _timeoutSec.

affinityCookieTtlSec

BackendService affinityCookieTtlSec.

backends

BackendService backends.

cdnPolicy

BackendService cdnPolicy.

circuitBreakers

BackendService circuitBreakers.

compressionMode

BackendService compressionMode.

connectionDraining

BackendService connectionDraining.

connectionTrackingPolicy

BackendService connectionTrackingPolicy.

consistentHash

BackendService consistentHash.

creationTimestamp

BackendService creationTimestamp.

customRequestHeaders

BackendService customRequestHeaders.

customResponseHeaders

BackendService customResponseHeaders.

description

BackendService description.

edgeSecurityPolicy

BackendService edgeSecurityPolicy.

enableCDN

BackendService enableCDN.

failoverPolicy

BackendService failoverPolicy.

fingerprint

BackendService fingerprint.

healthChecks

BackendService healthChecks.

iap

BackendService iap.

id

BackendService id.

kind

BackendService kind.

loadBalancingScheme

BackendService loadBalancingScheme.

localityLbPolicies

BackendService localityLbPolicies.

localityLbPolicy

BackendService localityLbPolicy.

logConfig

BackendService logConfig.

maxStreamDuration

BackendService maxStreamDuration.

name

BackendService name.

network

BackendService network.

outlierDetection

BackendService outlierDetection.

port

BackendService port.

portName

BackendService portName.

protocol

BackendService protocol.

region

BackendService region.

securityPolicy

BackendService securityPolicy.

securitySettings

BackendService securitySettings.

BackendService selfLink.

serviceBindings

BackendService serviceBindings.

sessionAffinity

BackendService sessionAffinity.

subsetting

BackendService subsetting.

timeoutSec

BackendService timeoutSec.

CompressionMode

CompressionMode enum.

Properties:
Name Type Description
UNDEFINED_COMPRESSION_MODE number

UNDEFINED_COMPRESSION_MODE value
AUTOMATIC number

AUTOMATIC value
DISABLED number

DISABLED value

LoadBalancingScheme

LoadBalancingScheme enum.

Properties:
Name Type Description
UNDEFINED_LOAD_BALANCING_SCHEME number

UNDEFINED_LOAD_BALANCING_SCHEME value
EXTERNAL number

EXTERNAL value
EXTERNAL_MANAGED number

EXTERNAL_MANAGED value
INTERNAL number

INTERNAL value
INTERNAL_MANAGED number

INTERNAL_MANAGED value
INTERNAL_SELF_MANAGED number

INTERNAL_SELF_MANAGED value
INVALID_LOAD_BALANCING_SCHEME number

INVALID_LOAD_BALANCING_SCHEME value

LocalityLbPolicy

LocalityLbPolicy enum.

Properties:
Name Type Description
UNDEFINED_LOCALITY_LB_POLICY number

UNDEFINED_LOCALITY_LB_POLICY value
INVALID_LB_POLICY number

INVALID_LB_POLICY value
LEAST_REQUEST number

LEAST_REQUEST value
MAGLEV number

MAGLEV value
ORIGINAL_DESTINATION number

ORIGINAL_DESTINATION value
RANDOM number

RANDOM value
RING_HASH number

RING_HASH value
ROUND_ROBIN number

ROUND_ROBIN value
WEIGHTED_MAGLEV number

WEIGHTED_MAGLEV value

Protocol

Protocol enum.

Properties:
Name Type Description
UNDEFINED_PROTOCOL number

UNDEFINED_PROTOCOL value
GRPC number

GRPC value
HTTP number

HTTP value
HTTP2 number

HTTP2 value
HTTPS number

HTTPS value
SSL number

SSL value
TCP number

TCP value
UDP number

UDP value
UNSPECIFIED number

UNSPECIFIED value

SessionAffinity

SessionAffinity enum.

Properties:
Name Type Description
UNDEFINED_SESSION_AFFINITY number

UNDEFINED_SESSION_AFFINITY value
CLIENT_IP number

CLIENT_IP value
CLIENT_IP_NO_DESTINATION number

CLIENT_IP_NO_DESTINATION value
CLIENT_IP_PORT_PROTO number

CLIENT_IP_PORT_PROTO value
CLIENT_IP_PROTO number

CLIENT_IP_PROTO value
GENERATED_COOKIE number

GENERATED_COOKIE value
HEADER_FIELD number

HEADER_FIELD value
HTTP_COOKIE number

HTTP_COOKIE value
NONE number

NONE value

Methods

toJSON() → {Object.<string, *>}

Converts this BackendService to JSON.

Returns:
Type Description
Object.<string, *>

JSON object

(static) create(propertiesopt) → {google.cloud.compute.v1.BackendService}

Creates a new BackendService instance using the specified properties.

Parameters:
Name Type Attributes Description
properties google.cloud.compute.v1.IBackendService <optional>

Properties to set
Returns:
Type Description
google.cloud.compute.v1.BackendService

BackendService instance

(static) decode(reader, lengthopt) → {google.cloud.compute.v1.BackendService}

Decodes a BackendService message from the specified reader or buffer.

Parameters:
Name Type Attributes Description
reader $protobuf.Reader | Uint8Array

Reader or buffer to decode from
length number <optional>

Message length if known beforehand
Returns:
Type Description
google.cloud.compute.v1.BackendService

BackendService
Throws:

  • If the payload is not a reader or valid buffer

    Type
    Error

  • If required fields are missing

    Type
    $protobuf.util.ProtocolError

(static) decodeDelimited(reader) → {google.cloud.compute.v1.BackendService}

Decodes a BackendService message from the specified reader or buffer, length delimited.

Parameters:
Name Type Description
reader $protobuf.Reader | Uint8Array

Reader or buffer to decode from
Returns:
Type Description
google.cloud.compute.v1.BackendService

BackendService
Throws:

  • If the payload is not a reader or valid buffer

    Type
    Error

  • If required fields are missing

    Type
    $protobuf.util.ProtocolError

(static) encode(message, writeropt) → {$protobuf.Writer}

Encodes the specified BackendService message. Does not implicitly verify messages.

Parameters:
Name Type Attributes Description
message google.cloud.compute.v1.IBackendService

BackendService message or plain object to encode
writer $protobuf.Writer <optional>

Writer to encode to
Returns:
Type Description
$protobuf.Writer

Writer

(static) encodeDelimited(message, writeropt) → {$protobuf.Writer}

Encodes the specified BackendService message, length delimited. Does not implicitly verify messages.

Parameters:
Name Type Attributes Description
message google.cloud.compute.v1.IBackendService

BackendService message or plain object to encode
writer $protobuf.Writer <optional>

Writer to encode to
Returns:
Type Description
$protobuf.Writer

Writer

(static) fromObject(object) → {google.cloud.compute.v1.BackendService}

Creates a BackendService message from a plain object. Also converts values to their respective internal types.

Parameters:
Name Type Description
object Object.<string, *>

Plain object
Returns:
Type Description
google.cloud.compute.v1.BackendService

BackendService

(static) getTypeUrl(typeUrlPrefixopt) → {string}

Gets the default type url for BackendService

Parameters:
Name Type Attributes Description
typeUrlPrefix string <optional>

your custom typeUrlPrefix(default "type.googleapis.com")
Returns:
Type Description
string

The default type url

(static) toObject(message, optionsopt) → {Object.<string, *>}

Creates a plain object from a BackendService message. Also converts values to other types if specified.

Parameters:
Name Type Attributes Description
message google.cloud.compute.v1.BackendService

BackendService
options $protobuf.IConversionOptions <optional>

Conversion options
Returns:
Type Description
Object.<string, *>

Plain object

(static) verify(message) → {string|null}

Verifies a BackendService message.

Parameters:
Name Type Description
message Object.<string, *>

Plain object to verify
Returns:
Type Description
string | null

null if valid, otherwise the reason why it is not