Class protos.google.cloud.osconfig.v1alpha.OSPolicy (1.10.0)

Version 1.10.0

• 2.2.2 (latest)
• 2.2.1
• 2.1.2
• 1.12.1
• 1.11.0
• 1.10.0
• 1.9.1
• 1.8.0
• 1.7.0
• 1.6.6

Represents a OSPolicy.

Package

@google-cloud/os-config

Constructors

(constructor)(properties)

constructor(properties?: google.cloud.osconfig.v1alpha.IOSPolicy);

Constructs a new OSPolicy.

Parameter

Name	Description
properties	IOSPolicy Properties to set

Properties

allowNoResourceGroupMatch

public allowNoResourceGroupMatch: boolean;

OSPolicy allowNoResourceGroupMatch.

Property Value

Type	Description
boolean

description

public description: string;

OSPolicy description.

Property Value

Type	Description
string

id

public id: string;

OSPolicy id.

Property Value

Type	Description
string

mode

public mode: (google.cloud.osconfig.v1alpha.OSPolicy.Mode|keyof typeof google.cloud.osconfig.v1alpha.OSPolicy.Mode);

OSPolicy mode.

Property Value

Type	Description
(google.cloud.osconfig.v1alpha.OSPolicy.Mode|keyof typeof google.cloud.osconfig.v1alpha.OSPolicy.Mode)

resourceGroups

public resourceGroups: google.cloud.osconfig.v1alpha.OSPolicy.IResourceGroup[];

OSPolicy resourceGroups.

Property Value

Type	Description
google.cloud.osconfig.v1alpha.OSPolicy.IResourceGroup[]

Methods

create(properties)

public static create(properties?: google.cloud.osconfig.v1alpha.IOSPolicy): google.cloud.osconfig.v1alpha.OSPolicy;

Creates a new OSPolicy instance using the specified properties.

Parameter

Name	Description
properties	IOSPolicy Properties to set

Returns

Type	Description
google.cloud.osconfig.v1alpha.OSPolicy	OSPolicy instance

decode(reader, length)

public static decode(reader: ($protobuf.Reader|Uint8Array), length?: number): google.cloud.osconfig.v1alpha.OSPolicy;

Decodes a OSPolicy 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.osconfig.v1alpha.OSPolicy	OSPolicy

decodeDelimited(reader)

public static decodeDelimited(reader: ($protobuf.Reader|Uint8Array)): google.cloud.osconfig.v1alpha.OSPolicy;

Decodes a OSPolicy 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.osconfig.v1alpha.OSPolicy	OSPolicy

encode(message, writer)

public static encode(message: google.cloud.osconfig.v1alpha.IOSPolicy, writer?: $protobuf.Writer): $protobuf.Writer;

Encodes the specified OSPolicy message. Does not implicitly messages.

Parameters

Name	Description
message	IOSPolicy OSPolicy 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.osconfig.v1alpha.IOSPolicy, writer?: $protobuf.Writer): $protobuf.Writer;

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

Parameters

Name	Description
message	IOSPolicy OSPolicy 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.osconfig.v1alpha.OSPolicy;

Creates a OSPolicy 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.osconfig.v1alpha.OSPolicy	OSPolicy

toJSON()

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

Converts this OSPolicy to JSON.

Returns

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

toObject(message, options)

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

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

Parameters

Name	Description
message	google.cloud.osconfig.v1alpha.OSPolicy OSPolicy
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 OSPolicy 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