Class protos.google.cloud.apigeeconnect.v1.Url (3.0.2)

Represents an Url.

Package

@google-cloud/apigee-connect

Constructors

(constructor)(properties)

constructor(properties?: google.cloud.apigeeconnect.v1.IUrl);

Constructs a new Url.

Parameter
NameDescription
properties IUrl

Properties to set

Properties

host

public host: string;

Url host.

path

public path: string;

Url path.

scheme

public scheme: (google.cloud.apigeeconnect.v1.Scheme|keyof typeof google.cloud.apigeeconnect.v1.Scheme);

Url scheme.

Methods

create(properties)

public static create(properties?: google.cloud.apigeeconnect.v1.IUrl): google.cloud.apigeeconnect.v1.Url;

Creates a new Url instance using the specified properties.

Parameter
NameDescription
properties IUrl

Properties to set

Returns
TypeDescription
Url

Url instance

decode(reader, length)

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

Decodes an Url message from the specified reader or buffer.

Parameters
NameDescription
reader (Reader|Uint8Array)

Reader or buffer to decode from

length number

Message length if known beforehand

Returns
TypeDescription
Url

Url

decodeDelimited(reader)

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

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

Parameter
NameDescription
reader (Reader|Uint8Array)

Reader or buffer to decode from

Returns
TypeDescription
Url

Url

encode(message, writer)

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

Encodes the specified Url message. Does not implicitly messages.

Parameters
NameDescription
message IUrl

Url message or plain object to encode

writer $protobuf.Writer

Writer to encode to

Returns
TypeDescription
$protobuf.Writer

Writer

encodeDelimited(message, writer)

public static encodeDelimited(message: google.cloud.apigeeconnect.v1.IUrl, writer?: $protobuf.Writer): $protobuf.Writer;

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

Parameters
NameDescription
message IUrl

Url message or plain object to encode

writer $protobuf.Writer

Writer to encode to

Returns
TypeDescription
$protobuf.Writer

Writer

fromObject(object)

public static fromObject(object: { [k: string]: any }): google.cloud.apigeeconnect.v1.Url;

Creates an Url message from a plain object. Also converts values to their respective internal types.

Parameter
NameDescription
object { [k: string]: any }

Plain object

Returns
TypeDescription
Url

Url

getTypeUrl(typeUrlPrefix)

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

Gets the default type url for Url

Parameter
NameDescription
typeUrlPrefix string

your custom typeUrlPrefix(default "type.googleapis.com")

Returns
TypeDescription
string

The default type url

toJSON()

public toJSON(): { [k: string]: any };

Converts this Url to JSON.

Returns
TypeDescription
{ [k: string]: any }

JSON object

toObject(message, options)

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

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

Parameters
NameDescription
message Url

Url

options $protobuf.IConversionOptions

Conversion options

Returns
TypeDescription
{ [k: string]: any }

Plain object

verify(message)

public static verify(message: { [k: string]: any }): (string|null);

Verifies an Url message.

Parameter
NameDescription
message { [k: string]: any }

Plain object to verify

Returns
TypeDescription
(string|null)

null if valid, otherwise the reason why it is not