Class protos.google.cloud.ids.v1.Endpoint (2.1.2)

Represents an Endpoint.

Package

@google-cloud/ids

Constructors

(constructor)(properties)

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

Constructs a new Endpoint.

Parameter
Name Description
properties IEndpoint

Properties to set

Properties

createTime

public createTime?: (google.protobuf.ITimestamp|null);

Endpoint createTime.

description

public description: string;

Endpoint description.

endpointForwardingRule

public endpointForwardingRule: string;

Endpoint endpointForwardingRule.

endpointIp

public endpointIp: string;

Endpoint endpointIp.

labels

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

Endpoint labels.

name

public name: string;

Endpoint name.

network

public network: string;

Endpoint network.

severity

public severity: (google.cloud.ids.v1.Endpoint.Severity|keyof typeof google.cloud.ids.v1.Endpoint.Severity);

Endpoint severity.

state

public state: (google.cloud.ids.v1.Endpoint.State|keyof typeof google.cloud.ids.v1.Endpoint.State);

Endpoint state.

trafficLogs

public trafficLogs: boolean;

Endpoint trafficLogs.

updateTime

public updateTime?: (google.protobuf.ITimestamp|null);

Endpoint updateTime.

Methods

create(properties)

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

Creates a new Endpoint instance using the specified properties.

Parameter
Name Description
properties IEndpoint

Properties to set
Returns
Type Description
google.cloud.ids.v1.Endpoint

Endpoint instance

decode(reader, length)

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

Decodes an Endpoint message from the specified reader or buffer.

Parameters
Name Description
reader ($protobuf.Reader|Uint8Array)

Reader or buffer to decode from
length number

Message length if known beforehand
Returns
Type Description
google.cloud.ids.v1.Endpoint

Endpoint

decodeDelimited(reader)

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

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

Parameter
Name Description
reader ($protobuf.Reader|Uint8Array)

Reader or buffer to decode from
Returns
Type Description
google.cloud.ids.v1.Endpoint

Endpoint

encode(message, writer)

public static encode(message: google.cloud.ids.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.ids.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.ids.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
google.cloud.ids.v1.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.ids.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 google.cloud.ids.v1.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