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

Represents a OSPolicyAssignment.

Package

@google-cloud/os-config

Constructors

(constructor)(properties)

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

Constructs a new OSPolicyAssignment.

Parameter
NameDescription
properties IOSPolicyAssignment

Properties to set

Properties

baseline

public baseline: boolean;

OSPolicyAssignment baseline.

Property Value
TypeDescription
boolean

deleted

public deleted: boolean;

OSPolicyAssignment deleted.

Property Value
TypeDescription
boolean

description

public description: string;

OSPolicyAssignment description.

Property Value
TypeDescription
string

instanceFilter

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

OSPolicyAssignment instanceFilter.

Property Value
TypeDescription
(google.cloud.osconfig.v1alpha.OSPolicyAssignment.IInstanceFilter|null)

name

public name: string;

OSPolicyAssignment name.

Property Value
TypeDescription
string

osPolicies

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

OSPolicyAssignment osPolicies.

Property Value
TypeDescription
google.cloud.osconfig.v1alpha.IOSPolicy[]

reconciling

public reconciling: boolean;

OSPolicyAssignment reconciling.

Property Value
TypeDescription
boolean

revisionCreateTime

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

OSPolicyAssignment revisionCreateTime.

Property Value
TypeDescription
(google.protobuf.ITimestamp|null)

revisionId

public revisionId: string;

OSPolicyAssignment revisionId.

Property Value
TypeDescription
string

rollout

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

OSPolicyAssignment rollout.

Property Value
TypeDescription
(google.cloud.osconfig.v1alpha.OSPolicyAssignment.IRollout|null)

rolloutState

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

OSPolicyAssignment rolloutState.

Property Value
TypeDescription
(google.cloud.osconfig.v1alpha.OSPolicyAssignment.RolloutState|keyof typeof google.cloud.osconfig.v1alpha.OSPolicyAssignment.RolloutState)

uid

public uid: string;

OSPolicyAssignment uid.

Property Value
TypeDescription
string

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
NameDescription
properties IOSPolicyAssignment

Properties to set

Returns
TypeDescription
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
NameDescription
reader ($protobuf.Reader|Uint8Array)

Reader or buffer to decode from

length number

Message length if known beforehand

Returns
TypeDescription
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
NameDescription
reader ($protobuf.Reader|Uint8Array)

Reader or buffer to decode from

Returns
TypeDescription
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
NameDescription
message IOSPolicyAssignment

OSPolicyAssignment 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.cloud.osconfig.v1alpha.IOSPolicyAssignment, writer?: $protobuf.Writer): $protobuf.Writer;

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

Parameters
NameDescription
message IOSPolicyAssignment

OSPolicyAssignment 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.cloud.osconfig.v1alpha.OSPolicyAssignment;

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

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

Plain object

Returns
TypeDescription
google.cloud.osconfig.v1alpha.OSPolicyAssignment

OSPolicyAssignment

toJSON()

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

Converts this OSPolicyAssignment to JSON.

Returns
TypeDescription
{ [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
NameDescription
message google.cloud.osconfig.v1alpha.OSPolicyAssignment

OSPolicyAssignment

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 OSPolicyAssignment 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