Some or all of the information on this page might not apply to Cloud de Confiance by S3NS. See Differences from Google Cloud for more details.

Class protos.google.cloud.osconfig.v1alpha.OSPolicyAssignment (1.12.1)

Represents a OSPolicyAssignment.

Package

@google-cloud/os-config

Constructors

(constructor)(properties)

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

Constructs a new OSPolicyAssignment.

Parameter

Name	Description
properties	`IOSPolicyAssignment` Properties to set

Properties

baseline

public baseline: boolean;

OSPolicyAssignment baseline.

deleted

public deleted: boolean;

OSPolicyAssignment deleted.

description

public description: string;

OSPolicyAssignment description.

etag

public etag: string;

OSPolicyAssignment etag.

instanceFilter

public instanceFilter?: (google.cloud.osconfig.v1alpha.OSPolicyAssignment.IInstanceFilter|null);

OSPolicyAssignment instanceFilter.

name

public name: string;

OSPolicyAssignment name.

osPolicies

public osPolicies: google.cloud.osconfig.v1alpha.IOSPolicy[];

OSPolicyAssignment osPolicies.

reconciling

public reconciling: boolean;

OSPolicyAssignment reconciling.

revisionCreateTime

public revisionCreateTime?: (google.protobuf.ITimestamp|null);

OSPolicyAssignment revisionCreateTime.

revisionId

public revisionId: string;

OSPolicyAssignment revisionId.

rollout

public rollout?: (google.cloud.osconfig.v1alpha.OSPolicyAssignment.IRollout|null);

OSPolicyAssignment rollout.

rolloutState

public rolloutState: (google.cloud.osconfig.v1alpha.OSPolicyAssignment.RolloutState|keyof typeof google.cloud.osconfig.v1alpha.OSPolicyAssignment.RolloutState);

OSPolicyAssignment rolloutState.

uid

public uid: string;

OSPolicyAssignment uid.

Methods

create(properties)

public static create(properties?: google.cloud.osconfig.v1alpha.IOSPolicyAssignment): google.cloud.osconfig.v1alpha.OSPolicyAssignment;

Creates a new OSPolicyAssignment instance using the specified properties.

Parameter

Name	Description
properties	`IOSPolicyAssignment` Properties to set

Returns

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

decode(reader, length)

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

Decodes a OSPolicyAssignment 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.OSPolicyAssignment	OSPolicyAssignment

decodeDelimited(reader)

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

Decodes a OSPolicyAssignment 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.OSPolicyAssignment	OSPolicyAssignment

encode(message, writer)

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

Encodes the specified OSPolicyAssignment message. Does not implicitly messages.

Parameters

Name	Description
message	`IOSPolicyAssignment` OSPolicyAssignment 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.IOSPolicyAssignment, writer?: $protobuf.Writer): $protobuf.Writer;

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

Parameters

Name	Description
message	`IOSPolicyAssignment` OSPolicyAssignment 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.OSPolicyAssignment;

Creates a OSPolicyAssignment 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.OSPolicyAssignment	OSPolicyAssignment

toJSON()

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

Converts this OSPolicyAssignment to JSON.

Returns

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

toObject(message, options)

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

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

Parameters

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