Class protos.google.cloud.chronicle.v1.Rapid7InsightSettings (0.10.1)

Represents a Rapid7InsightSettings.

Implements

Package

@google-cloud/chronicle

Constructors

(constructor)(properties)

constructor(properties?: google.cloud.chronicle.v1.IRapid7InsightSettings);

Constructs a new Rapid7InsightSettings.

Parameter
Name Description
properties IRapid7InsightSettings

Properties to set

Properties

authentication

public authentication?: (google.cloud.chronicle.v1.IHttpHeaderAuth|null);

Rapid7InsightSettings authentication.

endpoint

public endpoint: string;

Rapid7InsightSettings endpoint.

hostname

public hostname: string;

Rapid7InsightSettings hostname.

Methods

create(properties)

public static create(properties?: google.cloud.chronicle.v1.IRapid7InsightSettings): google.cloud.chronicle.v1.Rapid7InsightSettings;

Creates a new Rapid7InsightSettings instance using the specified properties.

Parameter
Name Description
properties IRapid7InsightSettings

Properties to set

Returns
Type Description
Rapid7InsightSettings

Rapid7InsightSettings instance

decode(reader, length)

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

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

Rapid7InsightSettings

decodeDelimited(reader)

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

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

Parameter
Name Description
reader (Reader|Uint8Array)

Reader or buffer to decode from

Returns
Type Description
Rapid7InsightSettings

Rapid7InsightSettings

encode(message, writer)

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

Encodes the specified Rapid7InsightSettings message. Does not implicitly messages.

Parameters
Name Description
message IRapid7InsightSettings

Rapid7InsightSettings 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.chronicle.v1.IRapid7InsightSettings, writer?: $protobuf.Writer): $protobuf.Writer;

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

Parameters
Name Description
message IRapid7InsightSettings

Rapid7InsightSettings 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.chronicle.v1.Rapid7InsightSettings;

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

Rapid7InsightSettings

getTypeUrl(typeUrlPrefix)

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

Gets the default type url for Rapid7InsightSettings

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

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

JSON object

toObject(message, options)

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

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

Parameters
Name Description
message Rapid7InsightSettings

Rapid7InsightSettings

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