Class protos.google.logging.v2.GetSettingsRequest (10.3.1)

Stay organized with collections Save and categorize content based on your preferences.

Represents a GetSettingsRequest.

Package

@google-cloud/logging

Constructors

(constructor)(properties)

constructor(properties?: google.logging.v2.IGetSettingsRequest);

Constructs a new GetSettingsRequest.

Parameter
NameDescription
properties IGetSettingsRequest

Properties to set

Properties

name

public name: string;

GetSettingsRequest name.

Methods

create(properties)

public static create(properties?: google.logging.v2.IGetSettingsRequest): google.logging.v2.GetSettingsRequest;

Creates a new GetSettingsRequest instance using the specified properties.

Parameter
NameDescription
properties IGetSettingsRequest

Properties to set

Returns
TypeDescription
google.logging.v2.GetSettingsRequest

GetSettingsRequest instance

decode(reader, length)

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

Decodes a GetSettingsRequest message from the specified reader or buffer.

Parameters
NameDescription
reader ($protobuf.Reader|Uint8Array)

Reader or buffer to decode from

length number

Message length if known beforehand

Returns
TypeDescription
google.logging.v2.GetSettingsRequest

GetSettingsRequest

decodeDelimited(reader)

public static decodeDelimited(reader: ($protobuf.Reader|Uint8Array)): google.logging.v2.GetSettingsRequest;

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

Parameter
NameDescription
reader ($protobuf.Reader|Uint8Array)

Reader or buffer to decode from

Returns
TypeDescription
google.logging.v2.GetSettingsRequest

GetSettingsRequest

encode(message, writer)

public static encode(message: google.logging.v2.IGetSettingsRequest, writer?: $protobuf.Writer): $protobuf.Writer;

Encodes the specified GetSettingsRequest message. Does not implicitly messages.

Parameters
NameDescription
message IGetSettingsRequest

GetSettingsRequest 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.logging.v2.IGetSettingsRequest, writer?: $protobuf.Writer): $protobuf.Writer;

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

Parameters
NameDescription
message IGetSettingsRequest

GetSettingsRequest 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.logging.v2.GetSettingsRequest;

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

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

Plain object

Returns
TypeDescription
google.logging.v2.GetSettingsRequest

GetSettingsRequest

getTypeUrl(typeUrlPrefix)

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

Gets the default type url for GetSettingsRequest

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

Returns
TypeDescription
{ [k: string]: any }

JSON object

toObject(message, options)

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

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

Parameters
NameDescription
message google.logging.v2.GetSettingsRequest

GetSettingsRequest

options $protobuf.IConversionOptions

Conversion options

Returns
TypeDescription
{ [k: string]: any }

Plain object

verify(message)

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

Verifies a GetSettingsRequest 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