Class protos.google.cloud.asset.v1.AnalyzerOrgPolicyConstraint.CustomConstraint (5.5.0)

Represents a CustomConstraint.

Package

@google-cloud/asset

Constructors

(constructor)(properties)

constructor(properties?: google.cloud.asset.v1.AnalyzerOrgPolicyConstraint.ICustomConstraint);

Constructs a new CustomConstraint.

Parameter
NameDescription
properties ICustomConstraint

Properties to set

Properties

actionType

public actionType: (google.cloud.asset.v1.AnalyzerOrgPolicyConstraint.CustomConstraint.ActionType|keyof typeof google.cloud.asset.v1.AnalyzerOrgPolicyConstraint.CustomConstraint.ActionType);

CustomConstraint actionType.

condition

public condition: string;

CustomConstraint condition.

description

public description: string;

CustomConstraint description.

displayName

public displayName: string;

CustomConstraint displayName.

methodTypes

public methodTypes: google.cloud.asset.v1.AnalyzerOrgPolicyConstraint.CustomConstraint.MethodType[];

CustomConstraint methodTypes.

name

public name: string;

CustomConstraint name.

resourceTypes

public resourceTypes: string[];

CustomConstraint resourceTypes.

Methods

create(properties)

public static create(properties?: google.cloud.asset.v1.AnalyzerOrgPolicyConstraint.ICustomConstraint): google.cloud.asset.v1.AnalyzerOrgPolicyConstraint.CustomConstraint;

Creates a new CustomConstraint instance using the specified properties.

Parameter
NameDescription
properties ICustomConstraint

Properties to set

Returns
TypeDescription
CustomConstraint

CustomConstraint instance

decode(reader, length)

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

Decodes a CustomConstraint message from the specified reader or buffer.

Parameters
NameDescription
reader (Reader|Uint8Array)

Reader or buffer to decode from

length number

Message length if known beforehand

Returns
TypeDescription
CustomConstraint

CustomConstraint

decodeDelimited(reader)

public static decodeDelimited(reader: ($protobuf.Reader|Uint8Array)): google.cloud.asset.v1.AnalyzerOrgPolicyConstraint.CustomConstraint;

Decodes a CustomConstraint message from the specified reader or buffer, length delimited.

Parameter
NameDescription
reader (Reader|Uint8Array)

Reader or buffer to decode from

Returns
TypeDescription
CustomConstraint

CustomConstraint

encode(message, writer)

public static encode(message: google.cloud.asset.v1.AnalyzerOrgPolicyConstraint.ICustomConstraint, writer?: $protobuf.Writer): $protobuf.Writer;

Encodes the specified CustomConstraint message. Does not implicitly messages.

Parameters
NameDescription
message ICustomConstraint

CustomConstraint 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.asset.v1.AnalyzerOrgPolicyConstraint.ICustomConstraint, writer?: $protobuf.Writer): $protobuf.Writer;

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

Parameters
NameDescription
message ICustomConstraint

CustomConstraint 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.asset.v1.AnalyzerOrgPolicyConstraint.CustomConstraint;

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

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

Plain object

Returns
TypeDescription
CustomConstraint

CustomConstraint

getTypeUrl(typeUrlPrefix)

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

Gets the default type url for CustomConstraint

Parameter
NameDescription
typeUrlPrefix string

your custom typeUrlPrefix(default "type.googleapis.com")

Returns
TypeDescription
string

The default type url

toJSON()

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

Converts this CustomConstraint to JSON.

Returns
TypeDescription
{ [k: string]: any }

JSON object

toObject(message, options)

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

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

Parameters
NameDescription
message CustomConstraint

CustomConstraint

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