Class protos.google.cloud.gkehub.configmanagement.v1alpha.PolicyController (4.2.0)

Represents a PolicyController.

Package

@google-cloud/gke-hub

Constructors

(constructor)(properties)

constructor(properties?: google.cloud.gkehub.configmanagement.v1alpha.IPolicyController);

Constructs a new PolicyController.

Parameter
Name Description
properties IPolicyController

Properties to set

Properties

_auditIntervalSeconds

public _auditIntervalSeconds?: "auditIntervalSeconds";

PolicyController _auditIntervalSeconds.

_templateLibraryInstalled

public _templateLibraryInstalled?: "templateLibraryInstalled";

PolicyController _templateLibraryInstalled.

auditIntervalSeconds

public auditIntervalSeconds?: (number|Long|string|null);

PolicyController auditIntervalSeconds.

enabled

public enabled: boolean;

PolicyController enabled.

exemptableNamespaces

public exemptableNamespaces: string[];

PolicyController exemptableNamespaces.

logDeniesEnabled

public logDeniesEnabled: boolean;

PolicyController logDeniesEnabled.

mutationEnabled

public mutationEnabled: boolean;

PolicyController mutationEnabled.

referentialRulesEnabled

public referentialRulesEnabled: boolean;

PolicyController referentialRulesEnabled.

templateLibraryInstalled

public templateLibraryInstalled?: (boolean|null);

PolicyController templateLibraryInstalled.

Methods

create(properties)

public static create(properties?: google.cloud.gkehub.configmanagement.v1alpha.IPolicyController): google.cloud.gkehub.configmanagement.v1alpha.PolicyController;

Creates a new PolicyController instance using the specified properties.

Parameter
Name Description
properties IPolicyController

Properties to set

Returns
Type Description
PolicyController

PolicyController instance

decode(reader, length)

public static decode(reader: ($protobuf.Reader|Uint8Array), length?: number): google.cloud.gkehub.configmanagement.v1alpha.PolicyController;

Decodes a PolicyController 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
PolicyController

PolicyController

decodeDelimited(reader)

public static decodeDelimited(reader: ($protobuf.Reader|Uint8Array)): google.cloud.gkehub.configmanagement.v1alpha.PolicyController;

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

Parameter
Name Description
reader (Reader|Uint8Array)

Reader or buffer to decode from

Returns
Type Description
PolicyController

PolicyController

encode(message, writer)

public static encode(message: google.cloud.gkehub.configmanagement.v1alpha.IPolicyController, writer?: $protobuf.Writer): $protobuf.Writer;

Encodes the specified PolicyController message. Does not implicitly messages.

Parameters
Name Description
message IPolicyController

PolicyController 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.gkehub.configmanagement.v1alpha.IPolicyController, writer?: $protobuf.Writer): $protobuf.Writer;

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

Parameters
Name Description
message IPolicyController

PolicyController 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.gkehub.configmanagement.v1alpha.PolicyController;

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

PolicyController

getTypeUrl(typeUrlPrefix)

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

Gets the default type url for PolicyController

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

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

JSON object

toObject(message, options)

public static toObject(message: google.cloud.gkehub.configmanagement.v1alpha.PolicyController, options?: $protobuf.IConversionOptions): { [k: string]: any };

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

Parameters
Name Description
message PolicyController

PolicyController

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