Class protos.google.cloud.deploy.v1.DeployPolicyEvaluationEvent (5.0.1)

Represents a DeployPolicyEvaluationEvent.

Package

@google-cloud/deploy

Constructors

(constructor)(properties)

constructor(properties?: google.cloud.deploy.v1.IDeployPolicyEvaluationEvent);

Constructs a new DeployPolicyEvaluationEvent.

Parameter
Name Description
properties IDeployPolicyEvaluationEvent

Properties to set

Properties

allowed

public allowed: boolean;

DeployPolicyEvaluationEvent allowed.

deliveryPipeline

public deliveryPipeline: string;

DeployPolicyEvaluationEvent deliveryPipeline.

deployPolicy

public deployPolicy: string;

DeployPolicyEvaluationEvent deployPolicy.

deployPolicyUid

public deployPolicyUid: string;

DeployPolicyEvaluationEvent deployPolicyUid.

invoker

public invoker: (google.cloud.deploy.v1.DeployPolicy.Invoker|keyof typeof google.cloud.deploy.v1.DeployPolicy.Invoker);

DeployPolicyEvaluationEvent invoker.

message

public message: string;

DeployPolicyEvaluationEvent message.

overrides

public overrides: google.cloud.deploy.v1.DeployPolicyEvaluationEvent.PolicyVerdictOverride[];

DeployPolicyEvaluationEvent overrides.

pipelineUid

public pipelineUid: string;

DeployPolicyEvaluationEvent pipelineUid.

rule

public rule: string;

DeployPolicyEvaluationEvent rule.

ruleType

public ruleType: string;

DeployPolicyEvaluationEvent ruleType.

target

public target: string;

DeployPolicyEvaluationEvent target.

targetUid

public targetUid: string;

DeployPolicyEvaluationEvent targetUid.

verdict

public verdict: (google.cloud.deploy.v1.DeployPolicyEvaluationEvent.PolicyVerdict|keyof typeof google.cloud.deploy.v1.DeployPolicyEvaluationEvent.PolicyVerdict);

DeployPolicyEvaluationEvent verdict.

Methods

create(properties)

public static create(properties?: google.cloud.deploy.v1.IDeployPolicyEvaluationEvent): google.cloud.deploy.v1.DeployPolicyEvaluationEvent;

Creates a new DeployPolicyEvaluationEvent instance using the specified properties.

Parameter
Name Description
properties IDeployPolicyEvaluationEvent

Properties to set

Returns
Type Description
DeployPolicyEvaluationEvent

DeployPolicyEvaluationEvent instance

decode(reader, length)

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

Decodes a DeployPolicyEvaluationEvent message from the specified reader or buffer.

Parameters
Name Description
reader (Reader|Uint8Array)

Reader or buffer to decode from

length number

Message length if known beforehand

Returns
Type Description
DeployPolicyEvaluationEvent

DeployPolicyEvaluationEvent

decodeDelimited(reader)

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

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

Parameter
Name Description
reader (Reader|Uint8Array)

Reader or buffer to decode from

Returns
Type Description
DeployPolicyEvaluationEvent

DeployPolicyEvaluationEvent

encode(message, writer)

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

Encodes the specified DeployPolicyEvaluationEvent message. Does not implicitly messages.

Parameters
Name Description
message IDeployPolicyEvaluationEvent

DeployPolicyEvaluationEvent 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.deploy.v1.IDeployPolicyEvaluationEvent, writer?: $protobuf.Writer): $protobuf.Writer;

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

Parameters
Name Description
message IDeployPolicyEvaluationEvent

DeployPolicyEvaluationEvent 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.deploy.v1.DeployPolicyEvaluationEvent;

Creates a DeployPolicyEvaluationEvent 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
DeployPolicyEvaluationEvent

DeployPolicyEvaluationEvent

getTypeUrl(typeUrlPrefix)

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

Gets the default type url for DeployPolicyEvaluationEvent

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

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

JSON object

toObject(message, options)

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

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

Parameters
Name Description
message DeployPolicyEvaluationEvent

DeployPolicyEvaluationEvent

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