Class protos.google.cloud.osconfig.v1alpha.OSPolicyAssignmentReport.OSPolicyCompliance.OSPolicyResourceCompliance (2.2.2)

Represents a OSPolicyResourceCompliance.

Package

@google-cloud/os-config

Constructors

(constructor)(properties)

constructor(properties?: google.cloud.osconfig.v1alpha.OSPolicyAssignmentReport.OSPolicyCompliance.IOSPolicyResourceCompliance);

Constructs a new OSPolicyResourceCompliance.

Parameter
Name Description
properties IOSPolicyResourceCompliance

Properties to set

Properties

complianceState

public complianceState: (google.cloud.osconfig.v1alpha.OSPolicyAssignmentReport.OSPolicyCompliance.OSPolicyResourceCompliance.ComplianceState|keyof typeof google.cloud.osconfig.v1alpha.OSPolicyAssignmentReport.OSPolicyCompliance.OSPolicyResourceCompliance.ComplianceState);

OSPolicyResourceCompliance complianceState.

complianceStateReason

public complianceStateReason: string;

OSPolicyResourceCompliance complianceStateReason.

configSteps

public configSteps: google.cloud.osconfig.v1alpha.OSPolicyAssignmentReport.OSPolicyCompliance.OSPolicyResourceCompliance.IOSPolicyResourceConfigStep[];

OSPolicyResourceCompliance configSteps.

execResourceOutput

public execResourceOutput?: (google.cloud.osconfig.v1alpha.OSPolicyAssignmentReport.OSPolicyCompliance.OSPolicyResourceCompliance.IExecResourceOutput|null);

OSPolicyResourceCompliance execResourceOutput.

osPolicyResourceId

public osPolicyResourceId: string;

OSPolicyResourceCompliance osPolicyResourceId.

output

public output?: "execResourceOutput";

OSPolicyResourceCompliance output.

Methods

create(properties)

public static create(properties?: google.cloud.osconfig.v1alpha.OSPolicyAssignmentReport.OSPolicyCompliance.IOSPolicyResourceCompliance): google.cloud.osconfig.v1alpha.OSPolicyAssignmentReport.OSPolicyCompliance.OSPolicyResourceCompliance;

Creates a new OSPolicyResourceCompliance instance using the specified properties.

Parameter
Name Description
properties IOSPolicyResourceCompliance

Properties to set
Returns
Type Description
google.cloud.osconfig.v1alpha.OSPolicyAssignmentReport.OSPolicyCompliance.OSPolicyResourceCompliance

OSPolicyResourceCompliance instance

decode(reader, length)

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

Decodes a OSPolicyResourceCompliance 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.OSPolicyAssignmentReport.OSPolicyCompliance.OSPolicyResourceCompliance

OSPolicyResourceCompliance

decodeDelimited(reader)

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

Decodes a OSPolicyResourceCompliance 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.OSPolicyAssignmentReport.OSPolicyCompliance.OSPolicyResourceCompliance

OSPolicyResourceCompliance

encode(message, writer)

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

Encodes the specified OSPolicyResourceCompliance message. Does not implicitly messages.

Parameters
Name Description
message IOSPolicyResourceCompliance

OSPolicyResourceCompliance 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.OSPolicyAssignmentReport.OSPolicyCompliance.IOSPolicyResourceCompliance, writer?: $protobuf.Writer): $protobuf.Writer;

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

Parameters
Name Description
message IOSPolicyResourceCompliance

OSPolicyResourceCompliance 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.OSPolicyAssignmentReport.OSPolicyCompliance.OSPolicyResourceCompliance;

Creates a OSPolicyResourceCompliance 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.OSPolicyAssignmentReport.OSPolicyCompliance.OSPolicyResourceCompliance

OSPolicyResourceCompliance

getTypeUrl(typeUrlPrefix)

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

Gets the default type url for OSPolicyResourceCompliance

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

Returns
Type Description
{ [k: string]: any }

JSON object

toObject(message, options)

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

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

Parameters
Name Description
message google.cloud.osconfig.v1alpha.OSPolicyAssignmentReport.OSPolicyCompliance.OSPolicyResourceCompliance

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