Class protos.google.cloud.resourcesettings.v1.Setting (1.1.2)

Represents a Setting.

Package

Constructors

(constructor)(properties)

constructor(properties?: google.cloud.resourcesettings.v1.ISetting);

Constructs a new Setting.

Parameter

Name	Description
properties	`ISetting` Properties to set

Properties

effectiveValue

public effectiveValue?: (google.cloud.resourcesettings.v1.IValue|null);

Setting effectiveValue.

etag

public etag: string;

Setting etag.

localValue

public localValue?: (google.cloud.resourcesettings.v1.IValue|null);

Setting localValue.

metadata

public metadata?: (google.cloud.resourcesettings.v1.ISettingMetadata|null);

Setting metadata.

name

public name: string;

Setting name.

Methods

create(properties)

public static create(properties?: google.cloud.resourcesettings.v1.ISetting): google.cloud.resourcesettings.v1.Setting;

Creates a new Setting instance using the specified properties.

Parameter

Name	Description
properties	`ISetting` Properties to set

Returns

Type	Description
google.cloud.resourcesettings.v1.Setting	Setting instance

decode(reader, length)

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

Decodes a Setting 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.cloud.resourcesettings.v1.Setting	Setting

decodeDelimited(reader)

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

Decodes a Setting 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.cloud.resourcesettings.v1.Setting	Setting

encode(message, writer)

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

Encodes the specified Setting message. Does not implicitly messages.

Parameters

Name	Description
message	`ISetting` Setting 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.resourcesettings.v1.ISetting, writer?: $protobuf.Writer): $protobuf.Writer;

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

Parameters

Name	Description
message	`ISetting` Setting 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.resourcesettings.v1.Setting;

Creates a Setting 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.cloud.resourcesettings.v1.Setting	Setting

toJSON()

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

Converts this Setting to JSON.

Returns

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

toObject(message, options)

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

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

Parameters

Name	Description
message	`google.cloud.resourcesettings.v1.Setting` Setting
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 Setting 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