Class protos.google.cloud.binaryauthorization.v1beta1.Policy

Version 1.1.6

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

Represents a Policy.

Package

@google-cloud/binary-authorization!

Constructors

(constructor)(properties)

constructor(properties?: google.cloud.binaryauthorization.v1beta1.IPolicy);

Constructs a new Policy.

Parameter

Type	Name	Description
IPolicy	properties	Properties to set

Properties

admissionWhitelistPatterns

public admissionWhitelistPatterns: google.cloud.binaryauthorization.v1beta1.IAdmissionWhitelistPattern[];

Policy admissionWhitelistPatterns.

Property Value

Type	Description
google.cloud.binaryauthorization.v1beta1.IAdmissionWhitelistPattern[]

clusterAdmissionRules

public clusterAdmissionRules: { [k: string]: google.cloud.binaryauthorization.v1beta1.IAdmissionRule };

Policy clusterAdmissionRules.

Property Value

Type	Description
{ [k: string]: google.cloud.binaryauthorization.v1beta1.IAdmissionRule }

defaultAdmissionRule

public defaultAdmissionRule?: (google.cloud.binaryauthorization.v1beta1.IAdmissionRule|null);

Policy defaultAdmissionRule.

Property Value

Type	Description
(google.cloud.binaryauthorization.v1beta1.IAdmissionRule|null)

description

public description: string;

Policy description.

Property Value

Type	Description
string

globalPolicyEvaluationMode

public globalPolicyEvaluationMode: (google.cloud.binaryauthorization.v1beta1.Policy.GlobalPolicyEvaluationMode|keyof typeof google.cloud.binaryauthorization.v1beta1.Policy.GlobalPolicyEvaluationMode);

Policy globalPolicyEvaluationMode.

Property Value

Type	Description
(google.cloud.binaryauthorization.v1beta1.Policy.GlobalPolicyEvaluationMode|keyof typeof google.cloud.binaryauthorization.v1beta1.Policy.GlobalPolicyEvaluationMode)

name

public name: string;

Policy name.

Property Value

Type	Description
string

updateTime

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

Policy updateTime.

Property Value

Type	Description
(google.protobuf.ITimestamp|null)

Methods

create(properties)

public static create(properties?: google.cloud.binaryauthorization.v1beta1.IPolicy): google.cloud.binaryauthorization.v1beta1.Policy;

Creates a new Policy instance using the specified properties.

Parameter

Type	Name	Description
IPolicy	properties	Properties to set

Returns

Type	Description
google.cloud.binaryauthorization.v1beta1.Policy	Policy instance

decode(reader, length)

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

Decodes a Policy message from the specified reader or buffer.

Parameters

Type	Name	Description
($protobuf.Reader|Uint8Array)	reader	Reader or buffer to decode from
number	length	Message length if known beforehand

Returns

Type	Description
google.cloud.binaryauthorization.v1beta1.Policy	Policy

decodeDelimited(reader)

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

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

Parameter

Type	Name	Description
($protobuf.Reader|Uint8Array)	reader	Reader or buffer to decode from

Returns

Type	Description
google.cloud.binaryauthorization.v1beta1.Policy	Policy

encode(message, writer)

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

Encodes the specified Policy message. Does not implicitly messages.

Parameters

Type	Name	Description
IPolicy	message	Policy message or plain object to encode
$protobuf.Writer	writer	Writer to encode to

Returns

Type	Description
$protobuf.Writer	Writer

encodeDelimited(message, writer)

public static encodeDelimited(message: google.cloud.binaryauthorization.v1beta1.IPolicy, writer?: $protobuf.Writer): $protobuf.Writer;

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

Parameters

Type	Name	Description
IPolicy	message	Policy message or plain object to encode
$protobuf.Writer	writer	Writer to encode to

Returns

Type	Description
$protobuf.Writer	Writer

fromObject(object)

public static fromObject(object: { [k: string]: any }): google.cloud.binaryauthorization.v1beta1.Policy;

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

Parameter

Type	Name	Description
{ [k: string]: any }	object	Plain object

Returns

Type	Description
google.cloud.binaryauthorization.v1beta1.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.binaryauthorization.v1beta1.Policy, options?: $protobuf.IConversionOptions): { [k: string]: any };

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

Parameters

Type	Name	Description
google.cloud.binaryauthorization.v1beta1.Policy	message	Policy
$protobuf.IConversionOptions	options	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

Type	Name	Description
{ [k: string]: any }	message	Plain object to verify

Returns

Type	Description
(string|null)	null if valid, otherwise the reason why it is not