Class protos.google.cloud.compute.v1.ForwardingRule (4.5.0)

Represents a ForwardingRule.

Package

@google-cloud/compute

Constructors

(constructor)(properties)

constructor(properties?: google.cloud.compute.v1.IForwardingRule);

Constructs a new ForwardingRule.

Parameter
Name Description
properties IForwardingRule

Properties to set

Properties

_allowGlobalAccess

public _allowGlobalAccess?: "allowGlobalAccess";

ForwardingRule _allowGlobalAccess.

_allowPscGlobalAccess

public _allowPscGlobalAccess?: "allowPscGlobalAccess";

ForwardingRule _allowPscGlobalAccess.

_allPorts

public _allPorts?: "allPorts";

ForwardingRule _allPorts.

_backendService

public _backendService?: "backendService";

ForwardingRule _backendService.

_baseForwardingRule

public _baseForwardingRule?: "baseForwardingRule";

ForwardingRule _baseForwardingRule.

_creationTimestamp

public _creationTimestamp?: "creationTimestamp";

ForwardingRule _creationTimestamp.

_description

public _description?: "description";

ForwardingRule _description.

_fingerprint

public _fingerprint?: "fingerprint";

ForwardingRule _fingerprint.

_id

public _id?: "id";

ForwardingRule _id.

_IPAddress

public _IPAddress?: "IPAddress";

ForwardingRule _IPAddress.

_ipCollection

public _ipCollection?: "ipCollection";

ForwardingRule _ipCollection.

_IPProtocol

public _IPProtocol?: "IPProtocol";

ForwardingRule _IPProtocol.

_ipVersion

public _ipVersion?: "ipVersion";

ForwardingRule _ipVersion.

_isMirroringCollector

public _isMirroringCollector?: "isMirroringCollector";

ForwardingRule _isMirroringCollector.

_kind

public _kind?: "kind";

ForwardingRule _kind.

_labelFingerprint

public _labelFingerprint?: "labelFingerprint";

ForwardingRule _labelFingerprint.

_loadBalancingScheme

public _loadBalancingScheme?: "loadBalancingScheme";

ForwardingRule _loadBalancingScheme.

_name

public _name?: "name";

ForwardingRule _name.

_network

public _network?: "network";

ForwardingRule _network.

_networkTier

public _networkTier?: "networkTier";

ForwardingRule _networkTier.

_noAutomateDnsZone

public _noAutomateDnsZone?: "noAutomateDnsZone";

ForwardingRule _noAutomateDnsZone.

_portRange

public _portRange?: "portRange";

ForwardingRule _portRange.

_pscConnectionId

public _pscConnectionId?: "pscConnectionId";

ForwardingRule _pscConnectionId.

_pscConnectionStatus

public _pscConnectionStatus?: "pscConnectionStatus";

ForwardingRule _pscConnectionStatus.

_region

public _region?: "region";

ForwardingRule _region.

public _selfLink?: "selfLink";

ForwardingRule _selfLink.

_serviceLabel

public _serviceLabel?: "serviceLabel";

ForwardingRule _serviceLabel.

_serviceName

public _serviceName?: "serviceName";

ForwardingRule _serviceName.

_subnetwork

public _subnetwork?: "subnetwork";

ForwardingRule _subnetwork.

_target

public _target?: "target";

ForwardingRule _target.

allowGlobalAccess

public allowGlobalAccess?: (boolean|null);

ForwardingRule allowGlobalAccess.

allowPscGlobalAccess

public allowPscGlobalAccess?: (boolean|null);

ForwardingRule allowPscGlobalAccess.

allPorts

public allPorts?: (boolean|null);

ForwardingRule allPorts.

backendService

public backendService?: (string|null);

ForwardingRule backendService.

baseForwardingRule

public baseForwardingRule?: (string|null);

ForwardingRule baseForwardingRule.

creationTimestamp

public creationTimestamp?: (string|null);

ForwardingRule creationTimestamp.

description

public description?: (string|null);

ForwardingRule description.

fingerprint

public fingerprint?: (string|null);

ForwardingRule fingerprint.

id

public id?: (number|Long|string|null);

ForwardingRule id.

IPAddress

public IPAddress?: (string|null);

ForwardingRule IPAddress.

ipCollection

public ipCollection?: (string|null);

ForwardingRule ipCollection.

IPProtocol

public IPProtocol?: (string|null);

ForwardingRule IPProtocol.

ipVersion

public ipVersion?: (string|null);

ForwardingRule ipVersion.

isMirroringCollector

public isMirroringCollector?: (boolean|null);

ForwardingRule isMirroringCollector.

kind

public kind?: (string|null);

ForwardingRule kind.

labelFingerprint

public labelFingerprint?: (string|null);

ForwardingRule labelFingerprint.

labels

public labels: { [k: string]: string };

ForwardingRule labels.

loadBalancingScheme

public loadBalancingScheme?: (string|null);

ForwardingRule loadBalancingScheme.

metadataFilters

public metadataFilters: google.cloud.compute.v1.IMetadataFilter[];

ForwardingRule metadataFilters.

name

public name?: (string|null);

ForwardingRule name.

network

public network?: (string|null);

ForwardingRule network.

networkTier

public networkTier?: (string|null);

ForwardingRule networkTier.

noAutomateDnsZone

public noAutomateDnsZone?: (boolean|null);

ForwardingRule noAutomateDnsZone.

portRange

public portRange?: (string|null);

ForwardingRule portRange.

ports

public ports: string[];

ForwardingRule ports.

pscConnectionId

public pscConnectionId?: (number|Long|string|null);

ForwardingRule pscConnectionId.

pscConnectionStatus

public pscConnectionStatus?: (string|null);

ForwardingRule pscConnectionStatus.

region

public region?: (string|null);

ForwardingRule region.

public selfLink?: (string|null);

ForwardingRule selfLink.

serviceDirectoryRegistrations

public serviceDirectoryRegistrations: google.cloud.compute.v1.IForwardingRuleServiceDirectoryRegistration[];

ForwardingRule serviceDirectoryRegistrations.

serviceLabel

public serviceLabel?: (string|null);

ForwardingRule serviceLabel.

serviceName

public serviceName?: (string|null);

ForwardingRule serviceName.

sourceIpRanges

public sourceIpRanges: string[];

ForwardingRule sourceIpRanges.

subnetwork

public subnetwork?: (string|null);

ForwardingRule subnetwork.

target

public target?: (string|null);

ForwardingRule target.

Methods

create(properties)

public static create(properties?: google.cloud.compute.v1.IForwardingRule): google.cloud.compute.v1.ForwardingRule;

Creates a new ForwardingRule instance using the specified properties.

Parameter
Name Description
properties IForwardingRule

Properties to set

Returns
Type Description
ForwardingRule

ForwardingRule instance

decode(reader, length)

public static decode(reader: ($protobuf.Reader|Uint8Array), length?: number): google.cloud.compute.v1.ForwardingRule;

Decodes a ForwardingRule 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
ForwardingRule

ForwardingRule

decodeDelimited(reader)

public static decodeDelimited(reader: ($protobuf.Reader|Uint8Array)): google.cloud.compute.v1.ForwardingRule;

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

Parameter
Name Description
reader (Reader|Uint8Array)

Reader or buffer to decode from

Returns
Type Description
ForwardingRule

ForwardingRule

encode(message, writer)

public static encode(message: google.cloud.compute.v1.IForwardingRule, writer?: $protobuf.Writer): $protobuf.Writer;

Encodes the specified ForwardingRule message. Does not implicitly messages.

Parameters
Name Description
message IForwardingRule

ForwardingRule 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.IForwardingRule, writer?: $protobuf.Writer): $protobuf.Writer;

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

Parameters
Name Description
message IForwardingRule

ForwardingRule 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.ForwardingRule;

Creates a ForwardingRule 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
ForwardingRule

ForwardingRule

getTypeUrl(typeUrlPrefix)

public static getTypeUrl(typeUrlPrefix?: string): string;

Gets the default type url for ForwardingRule

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

Returns
Type Description
{ [k: string]: any }

JSON object

toObject(message, options)

public static toObject(message: google.cloud.compute.v1.ForwardingRule, options?: $protobuf.IConversionOptions): { [k: string]: any };

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

Parameters
Name Description
message ForwardingRule

ForwardingRule

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 ForwardingRule message.

Parameter
Name Description
message { [k: string]: any }

Plain object to verify

Returns
Type Description
(string|null)

null if valid, otherwise the reason why it is not