Class protos.google.cloud.networkmanagement.v1.Endpoint (3.7.0)

Represents an Endpoint.

Package

@google-cloud/network-management

Constructors

(constructor)(properties)

constructor(properties?: google.cloud.networkmanagement.v1.IEndpoint);

Constructs a new Endpoint.

Parameter
Name Description
properties IEndpoint

Properties to set

Properties

_forwardingRuleTarget

public _forwardingRuleTarget?: "forwardingRuleTarget";

Endpoint _forwardingRuleTarget.

_loadBalancerId

public _loadBalancerId?: "loadBalancerId";

Endpoint _loadBalancerId.

_loadBalancerType

public _loadBalancerType?: "loadBalancerType";

Endpoint _loadBalancerType.

appEngineVersion

public appEngineVersion?: (google.cloud.networkmanagement.v1.Endpoint.IAppEngineVersionEndpoint|null);

Endpoint appEngineVersion.

cloudFunction

public cloudFunction?: (google.cloud.networkmanagement.v1.Endpoint.ICloudFunctionEndpoint|null);

Endpoint cloudFunction.

cloudRunRevision

public cloudRunRevision?: (google.cloud.networkmanagement.v1.Endpoint.ICloudRunRevisionEndpoint|null);

Endpoint cloudRunRevision.

cloudSqlInstance

public cloudSqlInstance: string;

Endpoint cloudSqlInstance.

forwardingRule

public forwardingRule: string;

Endpoint forwardingRule.

forwardingRuleTarget

public forwardingRuleTarget?: (google.cloud.networkmanagement.v1.Endpoint.ForwardingRuleTarget|keyof typeof google.cloud.networkmanagement.v1.Endpoint.ForwardingRuleTarget|null);

Endpoint forwardingRuleTarget.

gkeMasterCluster

public gkeMasterCluster: string;

Endpoint gkeMasterCluster.

instance

public instance: string;

Endpoint instance.

ipAddress

public ipAddress: string;

Endpoint ipAddress.

loadBalancerId

public loadBalancerId?: (string|null);

Endpoint loadBalancerId.

loadBalancerType

public loadBalancerType?: (google.cloud.networkmanagement.v1.LoadBalancerType|keyof typeof google.cloud.networkmanagement.v1.LoadBalancerType|null);

Endpoint loadBalancerType.

network

public network: string;

Endpoint network.

networkType

public networkType: (google.cloud.networkmanagement.v1.Endpoint.NetworkType|keyof typeof google.cloud.networkmanagement.v1.Endpoint.NetworkType);

Endpoint networkType.

port

public port: number;

Endpoint port.

projectId

public projectId: string;

Endpoint projectId.

Methods

create(properties)

public static create(properties?: google.cloud.networkmanagement.v1.IEndpoint): google.cloud.networkmanagement.v1.Endpoint;

Creates a new Endpoint instance using the specified properties.

Parameter
Name Description
properties IEndpoint

Properties to set
Returns
Type Description
Endpoint

Endpoint instance

decode(reader, length)

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

Decodes an Endpoint 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
Endpoint

Endpoint

decodeDelimited(reader)

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

Decodes an Endpoint message from the specified reader or buffer, length delimited.

Parameter
Name Description
reader (Reader|Uint8Array)

Reader or buffer to decode from
Returns
Type Description
Endpoint

Endpoint

encode(message, writer)

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

Encodes the specified Endpoint message. Does not implicitly messages.

Parameters
Name Description
message IEndpoint

Endpoint 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.networkmanagement.v1.IEndpoint, writer?: $protobuf.Writer): $protobuf.Writer;

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

Parameters
Name Description
message IEndpoint

Endpoint 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.networkmanagement.v1.Endpoint;

Creates an Endpoint 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
Endpoint

Endpoint

getTypeUrl(typeUrlPrefix)

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

Gets the default type url for Endpoint

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

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

JSON object

toObject(message, options)

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

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

Parameters
Name Description
message Endpoint

Endpoint
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 an Endpoint 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