Class protos.google.cloud.orgpolicy.v1.Policy (3.16.1)

Represents a Policy.

Package

@google-cloud/asset!

Constructors

(constructor)(properties)

constructor(properties?: google.cloud.orgpolicy.v1.IPolicy);

Constructs a new Policy.

Parameter

Name	Description
properties	`IPolicy` Properties to set

Properties

booleanPolicy

public booleanPolicy?: (google.cloud.orgpolicy.v1.Policy.IBooleanPolicy|null);

Policy booleanPolicy.

Property Value

Type	Description
(google.cloud.orgpolicy.v1.Policy.IBooleanPolicy\|null)

constraint

public constraint: string;

Policy constraint.

Property Value

Type	Description
string

etag

public etag: (Uint8Array|string);

Policy etag.

Property Value

Type	Description
(Uint8Array\|string)

listPolicy

public listPolicy?: (google.cloud.orgpolicy.v1.Policy.IListPolicy|null);

Policy listPolicy.

Property Value

Type	Description
(google.cloud.orgpolicy.v1.Policy.IListPolicy\|null)

policyType

public policyType?: ("listPolicy"|"booleanPolicy"|"restoreDefault");

Policy policyType.

Property Value

Type	Description
("listPolicy"\|"booleanPolicy"\|"restoreDefault")

restoreDefault

public restoreDefault?: (google.cloud.orgpolicy.v1.Policy.IRestoreDefault|null);

Policy restoreDefault.

Property Value

Type	Description
(google.cloud.orgpolicy.v1.Policy.IRestoreDefault\|null)

updateTime

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

Policy updateTime.

Property Value

Type	Description
(google.protobuf.ITimestamp\|null)

version

public version: number;

Policy version.

Property Value

Type	Description
number

Methods

create(properties)

public static create(properties?: google.cloud.orgpolicy.v1.IPolicy): google.cloud.orgpolicy.v1.Policy;

Creates a new Policy instance using the specified properties.

Parameter

Name	Description
properties	`IPolicy` Properties to set

Returns

Type	Description
google.cloud.orgpolicy.v1.Policy	Policy instance

decode(reader, length)

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

Decodes a Policy 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.orgpolicy.v1.Policy	Policy

decodeDelimited(reader)

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

Decodes a Policy 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.orgpolicy.v1.Policy	Policy

encode(message, writer)

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

Encodes the specified Policy message. Does not implicitly messages.

Parameters

Name	Description
message	`IPolicy` Policy 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.orgpolicy.v1.IPolicy, writer?: $protobuf.Writer): $protobuf.Writer;

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

Parameters

Name	Description
message	`IPolicy` Policy 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.orgpolicy.v1.Policy;

Creates a Policy 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.orgpolicy.v1.Policy	Policy

toJSON()

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

Converts this Policy to JSON.

Returns

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

toObject(message, options)

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

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

Parameters

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