Class protos.google.api.CppSettings (0.3.1)

Version 0.3.1

• 1.10.0 (latest)
• 1.9.0
• 1.7.0
• 1.5.0
• 1.4.0
• 1.3.0
• 0.5.1
• 0.4.0
• 0.3.1
• 0.1.2

Represents a CppSettings.

Package

@google-cloud/contentwarehouse

Constructors

(constructor)(properties)

constructor(properties?: google.api.ICppSettings);

Constructs a new CppSettings.

Parameter

Name	Description
properties	ICppSettings Properties to set

Properties

common

public common?: (google.api.ICommonLanguageSettings|null);

CppSettings common.

Methods

create(properties)

public static create(properties?: google.api.ICppSettings): google.api.CppSettings;

Creates a new CppSettings instance using the specified properties.

Parameter

Name	Description
properties	ICppSettings Properties to set

Returns

Type	Description
google.api.CppSettings	CppSettings instance

decode(reader, length)

public static decode(reader: ($protobuf.Reader|Uint8Array), length?: number): google.api.CppSettings;

Decodes a CppSettings message from the specified reader or buffer.

Parameters

Name	Description
reader	($protobuf.Reader|Uint8Array) Reader or buffer to decode from
length	number Message length if known beforehand

Returns

Type	Description
google.api.CppSettings	CppSettings

decodeDelimited(reader)

public static decodeDelimited(reader: ($protobuf.Reader|Uint8Array)): google.api.CppSettings;

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

Parameter

Name	Description
reader	($protobuf.Reader|Uint8Array) Reader or buffer to decode from

Returns

Type	Description
google.api.CppSettings	CppSettings

encode(message, writer)

public static encode(message: google.api.ICppSettings, writer?: $protobuf.Writer): $protobuf.Writer;

Encodes the specified CppSettings message. Does not implicitly messages.

Parameters

Name	Description
message	ICppSettings CppSettings 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.api.ICppSettings, writer?: $protobuf.Writer): $protobuf.Writer;

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

Parameters

Name	Description
message	ICppSettings CppSettings 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.api.CppSettings;

Creates a CppSettings 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
google.api.CppSettings	CppSettings

getTypeUrl(typeUrlPrefix)

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

Gets the default type url for CppSettings

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

Returns

Type	Description
{ [k: string]: any }	JSON object

toObject(message, options)

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

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

Parameters

Name	Description
message	google.api.CppSettings CppSettings
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 CppSettings 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