Endpoint

google.cloud.servicedirectory.v1. Endpoint

Represents an Endpoint.

Constructor

new Endpoint(propertiesopt)

Constructs a new Endpoint.

Parameters:
Name Type Attributes Description
properties google.cloud.servicedirectory.v1.IEndpoint <optional>

Properties to set

Implements:
  • IEndpoint

Members

address

Endpoint address.

annotations

Endpoint annotations.

name

Endpoint name.

port

Endpoint port.

Methods

(static) create(propertiesopt) → {google.cloud.servicedirectory.v1.Endpoint}

Creates a new Endpoint instance using the specified properties.

Parameters:
Name Type Attributes Description
properties google.cloud.servicedirectory.v1.IEndpoint <optional>

Properties to set

Returns:
Type Description
google.cloud.servicedirectory.v1.Endpoint

Endpoint instance

(static) decode(reader, lengthopt) → {google.cloud.servicedirectory.v1.Endpoint}

Decodes an Endpoint 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.servicedirectory.v1.Endpoint

Endpoint

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.servicedirectory.v1.Endpoint}

Decodes an Endpoint 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.servicedirectory.v1.Endpoint

Endpoint

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

Parameters:
Name Type Attributes Description
message google.cloud.servicedirectory.v1.IEndpoint

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

Parameters:
Name Type Attributes Description
message google.cloud.servicedirectory.v1.IEndpoint

Endpoint 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.servicedirectory.v1.Endpoint}

Creates an Endpoint 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.servicedirectory.v1.Endpoint

Endpoint

(static) getTypeUrl(typeUrlPrefixopt) → {string}

Gets the default type url for Endpoint

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

Parameters:
Name Type Attributes Description
message google.cloud.servicedirectory.v1.Endpoint

Endpoint

options $protobuf.IConversionOptions <optional>

Conversion options

Returns:
Type Description
Object.<string, *>

Plain object

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

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

toJSON() → {Object.<string, *>}

Converts this Endpoint to JSON.

Returns:
Type Description
Object.<string, *>

JSON object