Represents a BackendService.
Package
@google-cloud/computeConstructors
(constructor)(properties)
constructor(properties?: google.cloud.compute.v1.IBackendService);Constructs a new BackendService.
| Parameter | |
|---|---|
| Name | Description |
properties |
IBackendService
Properties to set |
Properties
_affinityCookieTtlSec
public _affinityCookieTtlSec?: "affinityCookieTtlSec";BackendService _affinityCookieTtlSec.
_cdnPolicy
public _cdnPolicy?: "cdnPolicy";BackendService _cdnPolicy.
_circuitBreakers
public _circuitBreakers?: "circuitBreakers";BackendService _circuitBreakers.
_compressionMode
public _compressionMode?: "compressionMode";BackendService _compressionMode.
_connectionDraining
public _connectionDraining?: "connectionDraining";BackendService _connectionDraining.
_connectionTrackingPolicy
public _connectionTrackingPolicy?: "connectionTrackingPolicy";BackendService _connectionTrackingPolicy.
_consistentHash
public _consistentHash?: "consistentHash";BackendService _consistentHash.
_creationTimestamp
public _creationTimestamp?: "creationTimestamp";BackendService _creationTimestamp.
_description
public _description?: "description";BackendService _description.
_edgeSecurityPolicy
public _edgeSecurityPolicy?: "edgeSecurityPolicy";BackendService _edgeSecurityPolicy.
_enableCDN
public _enableCDN?: "enableCDN";BackendService _enableCDN.
_failoverPolicy
public _failoverPolicy?: "failoverPolicy";BackendService _failoverPolicy.
_fingerprint
public _fingerprint?: "fingerprint";BackendService _fingerprint.
_iap
public _iap?: "iap";BackendService _iap.
_id
public _id?: "id";BackendService _id.
_kind
public _kind?: "kind";BackendService _kind.
_loadBalancingScheme
public _loadBalancingScheme?: "loadBalancingScheme";BackendService _loadBalancingScheme.
_localityLbPolicy
public _localityLbPolicy?: "localityLbPolicy";BackendService _localityLbPolicy.
_logConfig
public _logConfig?: "logConfig";BackendService _logConfig.
_maxStreamDuration
public _maxStreamDuration?: "maxStreamDuration";BackendService _maxStreamDuration.
_name
public _name?: "name";BackendService _name.
_network
public _network?: "network";BackendService _network.
_outlierDetection
public _outlierDetection?: "outlierDetection";BackendService _outlierDetection.
_port
public _port?: "port";BackendService _port.
_portName
public _portName?: "portName";BackendService _portName.
_protocol
public _protocol?: "protocol";BackendService _protocol.
_region
public _region?: "region";BackendService _region.
_securityPolicy
public _securityPolicy?: "securityPolicy";BackendService _securityPolicy.
_securitySettings
public _securitySettings?: "securitySettings";BackendService _securitySettings.
_selfLink
public _selfLink?: "selfLink";BackendService _selfLink.
_serviceLbPolicy
public _serviceLbPolicy?: "serviceLbPolicy";BackendService _serviceLbPolicy.
_sessionAffinity
public _sessionAffinity?: "sessionAffinity";BackendService _sessionAffinity.
_subsetting
public _subsetting?: "subsetting";BackendService _subsetting.
_timeoutSec
public _timeoutSec?: "timeoutSec";BackendService _timeoutSec.
affinityCookieTtlSec
public affinityCookieTtlSec?: (number|null);BackendService affinityCookieTtlSec.
backends
public backends: google.cloud.compute.v1.IBackend[];BackendService backends.
cdnPolicy
public cdnPolicy?: (google.cloud.compute.v1.IBackendServiceCdnPolicy|null);BackendService cdnPolicy.
circuitBreakers
public circuitBreakers?: (google.cloud.compute.v1.ICircuitBreakers|null);BackendService circuitBreakers.
compressionMode
public compressionMode?: (string|null);BackendService compressionMode.
connectionDraining
public connectionDraining?: (google.cloud.compute.v1.IConnectionDraining|null);BackendService connectionDraining.
connectionTrackingPolicy
public connectionTrackingPolicy?: (google.cloud.compute.v1.IBackendServiceConnectionTrackingPolicy|null);BackendService connectionTrackingPolicy.
consistentHash
public consistentHash?: (google.cloud.compute.v1.IConsistentHashLoadBalancerSettings|null);BackendService consistentHash.
creationTimestamp
public creationTimestamp?: (string|null);BackendService creationTimestamp.
customRequestHeaders
public customRequestHeaders: string[];BackendService customRequestHeaders.
customResponseHeaders
public customResponseHeaders: string[];BackendService customResponseHeaders.
description
public description?: (string|null);BackendService description.
edgeSecurityPolicy
public edgeSecurityPolicy?: (string|null);BackendService edgeSecurityPolicy.
enableCDN
public enableCDN?: (boolean|null);BackendService enableCDN.
failoverPolicy
public failoverPolicy?: (google.cloud.compute.v1.IBackendServiceFailoverPolicy|null);BackendService failoverPolicy.
fingerprint
public fingerprint?: (string|null);BackendService fingerprint.
healthChecks
public healthChecks: string[];BackendService healthChecks.
iap
public iap?: (google.cloud.compute.v1.IBackendServiceIAP|null);BackendService iap.
id
public id?: (number|Long|string|null);BackendService id.
kind
public kind?: (string|null);BackendService kind.
loadBalancingScheme
public loadBalancingScheme?: (string|null);BackendService loadBalancingScheme.
localityLbPolicies
public localityLbPolicies: google.cloud.compute.v1.IBackendServiceLocalityLoadBalancingPolicyConfig[];BackendService localityLbPolicies.
localityLbPolicy
public localityLbPolicy?: (string|null);BackendService localityLbPolicy.
logConfig
public logConfig?: (google.cloud.compute.v1.IBackendServiceLogConfig|null);BackendService logConfig.
maxStreamDuration
public maxStreamDuration?: (google.cloud.compute.v1.IDuration|null);BackendService maxStreamDuration.
metadatas
public metadatas: { [k: string]: string };BackendService metadatas.
name
public name?: (string|null);BackendService name.
network
public network?: (string|null);BackendService network.
outlierDetection
public outlierDetection?: (google.cloud.compute.v1.IOutlierDetection|null);BackendService outlierDetection.
port
public port?: (number|null);BackendService port.
portName
public portName?: (string|null);BackendService portName.
protocol
public protocol?: (string|null);BackendService protocol.
region
public region?: (string|null);BackendService region.
securityPolicy
public securityPolicy?: (string|null);BackendService securityPolicy.
securitySettings
public securitySettings?: (google.cloud.compute.v1.ISecuritySettings|null);BackendService securitySettings.
selfLink
public selfLink?: (string|null);BackendService selfLink.
serviceBindings
public serviceBindings: string[];BackendService serviceBindings.
serviceLbPolicy
public serviceLbPolicy?: (string|null);BackendService serviceLbPolicy.
sessionAffinity
public sessionAffinity?: (string|null);BackendService sessionAffinity.
subsetting
public subsetting?: (google.cloud.compute.v1.ISubsetting|null);BackendService subsetting.
timeoutSec
public timeoutSec?: (number|null);BackendService timeoutSec.
usedBy
public usedBy: google.cloud.compute.v1.IBackendServiceUsedBy[];BackendService usedBy.
Methods
create(properties)
public static create(properties?: google.cloud.compute.v1.IBackendService): google.cloud.compute.v1.BackendService;Creates a new BackendService instance using the specified properties.
| Parameter | |
|---|---|
| Name | Description |
properties |
IBackendService
Properties to set |
| Returns | |
|---|---|
| Type | Description |
BackendService |
BackendService instance |
decode(reader, length)
public static decode(reader: ($protobuf.Reader|Uint8Array), length?: number): google.cloud.compute.v1.BackendService;Decodes a BackendService message from the specified reader or buffer.
| Parameters | |
|---|---|
| Name | Description |
reader |
(Reader|Uint8Array)
Reader or buffer to decode from |
length |
number
Message length if known beforehand |
| Returns | |
|---|---|
| Type | Description |
BackendService |
BackendService |
decodeDelimited(reader)
public static decodeDelimited(reader: ($protobuf.Reader|Uint8Array)): google.cloud.compute.v1.BackendService;Decodes a BackendService message from the specified reader or buffer, length delimited.
| Parameter | |
|---|---|
| Name | Description |
reader |
(Reader|Uint8Array)
Reader or buffer to decode from |
| Returns | |
|---|---|
| Type | Description |
BackendService |
BackendService |
encode(message, writer)
public static encode(message: google.cloud.compute.v1.IBackendService, writer?: $protobuf.Writer): $protobuf.Writer;Encodes the specified BackendService message. Does not implicitly messages.
| Parameters | |
|---|---|
| Name | Description |
message |
IBackendService
BackendService message or plain object to encode |
writer |
$protobuf.Writer
Writer to encode to |
| Returns | |
|---|---|
| Type | Description |
$protobuf.Writer |
Writer |
encodeDelimited(message, writer)
public static encodeDelimited(message: google.cloud.compute.v1.IBackendService, writer?: $protobuf.Writer): $protobuf.Writer;Encodes the specified BackendService message, length delimited. Does not implicitly messages.
| Parameters | |
|---|---|
| Name | Description |
message |
IBackendService
BackendService message or plain object to encode |
writer |
$protobuf.Writer
Writer to encode to |
| Returns | |
|---|---|
| Type | Description |
$protobuf.Writer |
Writer |
fromObject(object)
public static fromObject(object: { [k: string]: any }): google.cloud.compute.v1.BackendService;Creates a BackendService message from a plain object. Also converts values to their respective internal types.
| Parameter | |
|---|---|
| Name | Description |
object |
{ [k: string]: any }
Plain object |
| Returns | |
|---|---|
| Type | Description |
BackendService |
BackendService |
getTypeUrl(typeUrlPrefix)
public static getTypeUrl(typeUrlPrefix?: string): string;Gets the default type url for BackendService
| Parameter | |
|---|---|
| Name | Description |
typeUrlPrefix |
string
your custom typeUrlPrefix(default "type.googleapis.com") |
| Returns | |
|---|---|
| Type | Description |
string |
The default type url |
toJSON()
public toJSON(): { [k: string]: any };Converts this BackendService to JSON.
| Returns | |
|---|---|
| Type | Description |
{ [k: string]: any } |
JSON object |
toObject(message, options)
public static toObject(message: google.cloud.compute.v1.BackendService, options?: $protobuf.IConversionOptions): { [k: string]: any };Creates a plain object from a BackendService message. Also converts values to other types if specified.
| Parameters | |
|---|---|
| Name | Description |
message |
BackendService
BackendService |
options |
$protobuf.IConversionOptions
Conversion options |
| Returns | |
|---|---|
| Type | Description |
{ [k: string]: any } |
Plain object |
verify(message)
public static verify(message: { [k: string]: any }): (string|null);Verifies a BackendService message.
| Parameter | |
|---|---|
| Name | Description |
message |
{ [k: string]: any }
Plain object to verify |
| Returns | |
|---|---|
| Type | Description |
(string|null) |
|