Class protos.google.cloud.securitycenter.v2.Geolocation (8.11.0)

Represents a Geolocation.

Package

@google-cloud/security-center

Constructors

(constructor)(properties)

constructor(properties?: google.cloud.securitycenter.v2.IGeolocation);

Constructs a new Geolocation.

Parameter
Name Description
properties IGeolocation

Properties to set

Properties

regionCode

public regionCode: string;

Geolocation regionCode.

Methods

create(properties)

public static create(properties?: google.cloud.securitycenter.v2.IGeolocation): google.cloud.securitycenter.v2.Geolocation;

Creates a new Geolocation instance using the specified properties.

Parameter
Name Description
properties IGeolocation

Properties to set

Returns
Type Description
Geolocation

Geolocation instance

decode(reader, length)

public static decode(reader: ($protobuf.Reader|Uint8Array), length?: number): google.cloud.securitycenter.v2.Geolocation;

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

Geolocation

decodeDelimited(reader)

public static decodeDelimited(reader: ($protobuf.Reader|Uint8Array)): google.cloud.securitycenter.v2.Geolocation;

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

Parameter
Name Description
reader (Reader|Uint8Array)

Reader or buffer to decode from

Returns
Type Description
Geolocation

Geolocation

encode(message, writer)

public static encode(message: google.cloud.securitycenter.v2.IGeolocation, writer?: $protobuf.Writer): $protobuf.Writer;

Encodes the specified Geolocation message. Does not implicitly messages.

Parameters
Name Description
message IGeolocation

Geolocation 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.securitycenter.v2.IGeolocation, writer?: $protobuf.Writer): $protobuf.Writer;

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

Parameters
Name Description
message IGeolocation

Geolocation 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.securitycenter.v2.Geolocation;

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

Geolocation

getTypeUrl(typeUrlPrefix)

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

Gets the default type url for Geolocation

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

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

JSON object

toObject(message, options)

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

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

Parameters
Name Description
message Geolocation

Geolocation

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 Geolocation 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