TargetPool

google.cloud.compute.v1. TargetPool

Represents a TargetPool.

Constructor

new TargetPool(propertiesopt)

Constructs a new TargetPool.

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

Properties to set

Implements:
  • ITargetPool

Members

_backupPool

TargetPool _backupPool.

_creationTimestamp

TargetPool _creationTimestamp.

_description

TargetPool _description.

_failoverRatio

TargetPool _failoverRatio.

_id

TargetPool _id.

_kind

TargetPool _kind.

_name

TargetPool _name.

_region

TargetPool _region.

TargetPool _selfLink.

_sessionAffinity

TargetPool _sessionAffinity.

backupPool

TargetPool backupPool.

creationTimestamp

TargetPool creationTimestamp.

description

TargetPool description.

failoverRatio

TargetPool failoverRatio.

healthChecks

TargetPool healthChecks.

id

TargetPool id.

instances

TargetPool instances.

kind

TargetPool kind.

name

TargetPool name.

region

TargetPool region.

TargetPool selfLink.

sessionAffinity

TargetPool sessionAffinity.

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 TargetPool to JSON.

Returns:
Type Description
Object.<string, *>

JSON object

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

Creates a new TargetPool instance using the specified properties.

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

Properties to set

Returns:
Type Description
google.cloud.compute.v1.TargetPool

TargetPool instance

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

Decodes a TargetPool 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.TargetPool

TargetPool

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.TargetPool}

Decodes a TargetPool 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.TargetPool

TargetPool

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 TargetPool message. Does not implicitly verify messages.

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

TargetPool 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 TargetPool message, length delimited. Does not implicitly verify messages.

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

TargetPool 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.TargetPool}

Creates a TargetPool 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.TargetPool

TargetPool

(static) getTypeUrl(typeUrlPrefixopt) → {string}

Gets the default type url for TargetPool

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 TargetPool message. Also converts values to other types if specified.

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

TargetPool

options $protobuf.IConversionOptions <optional>

Conversion options

Returns:
Type Description
Object.<string, *>

Plain object

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

Verifies a TargetPool 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