Class protos.google.cloud.binaryauthorization.v1.AdmissionRule

Version 1.3.0

• 2.5.0 (latest)
• 2.2.1
• 2.1.1
• 1.5.1
• 1.4.0
• 1.3.0
• 1.2.0
• 1.1.6

Represents an AdmissionRule.

Package

@google-cloud/binary-authorization!

Constructors

(constructor)(properties)

constructor(properties?: google.cloud.binaryauthorization.v1.IAdmissionRule);

Constructs a new AdmissionRule.

Parameter

Name	Description
properties	IAdmissionRule Properties to set

Properties

enforcementMode

public enforcementMode: (google.cloud.binaryauthorization.v1.AdmissionRule.EnforcementMode|keyof typeof google.cloud.binaryauthorization.v1.AdmissionRule.EnforcementMode);

AdmissionRule enforcementMode.

Property Value

Type	Description
(google.cloud.binaryauthorization.v1.AdmissionRule.EnforcementMode|keyof typeof google.cloud.binaryauthorization.v1.AdmissionRule.EnforcementMode)

evaluationMode

public evaluationMode: (google.cloud.binaryauthorization.v1.AdmissionRule.EvaluationMode|keyof typeof google.cloud.binaryauthorization.v1.AdmissionRule.EvaluationMode);

AdmissionRule evaluationMode.

Property Value

Type	Description
(google.cloud.binaryauthorization.v1.AdmissionRule.EvaluationMode|keyof typeof google.cloud.binaryauthorization.v1.AdmissionRule.EvaluationMode)

requireAttestationsBy

public requireAttestationsBy: string[];

AdmissionRule requireAttestationsBy.

Property Value

Type	Description
string[]

Methods

create(properties)

public static create(properties?: google.cloud.binaryauthorization.v1.IAdmissionRule): google.cloud.binaryauthorization.v1.AdmissionRule;

Creates a new AdmissionRule instance using the specified properties.

Parameter

Name	Description
properties	IAdmissionRule Properties to set

Returns

Type	Description
google.cloud.binaryauthorization.v1.AdmissionRule	AdmissionRule instance

decode(reader, length)

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

Decodes an AdmissionRule 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.binaryauthorization.v1.AdmissionRule	AdmissionRule

decodeDelimited(reader)

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

Decodes an AdmissionRule 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.binaryauthorization.v1.AdmissionRule	AdmissionRule

encode(message, writer)

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

Encodes the specified AdmissionRule message. Does not implicitly messages.

Parameters

Name	Description
message	IAdmissionRule AdmissionRule 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.binaryauthorization.v1.IAdmissionRule, writer?: $protobuf.Writer): $protobuf.Writer;

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

Parameters

Name	Description
message	IAdmissionRule AdmissionRule 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.binaryauthorization.v1.AdmissionRule;

Creates an AdmissionRule 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.binaryauthorization.v1.AdmissionRule	AdmissionRule

toJSON()

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

Converts this AdmissionRule to JSON.

Returns

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

toObject(message, options)

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

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

Parameters

Name	Description
message	google.cloud.binaryauthorization.v1.AdmissionRule AdmissionRule
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 an AdmissionRule 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