Class protos.google.cloud.gkehub.policycontroller.v1beta.HubConfig (5.0.0)

Represents a HubConfig.

Package

@google-cloud/gke-hub

Constructors

(constructor)(properties)

constructor(properties?: google.cloud.gkehub.policycontroller.v1beta.IHubConfig);

Constructs a new HubConfig.

Parameter
Name Description
properties IHubConfig

Properties to set

Properties

_auditIntervalSeconds

public _auditIntervalSeconds?: "auditIntervalSeconds";

HubConfig _auditIntervalSeconds.

_constraintViolationLimit

public _constraintViolationLimit?: "constraintViolationLimit";

HubConfig _constraintViolationLimit.

_monitoring

public _monitoring?: "monitoring";

HubConfig _monitoring.

_policyContent

public _policyContent?: "policyContent";

HubConfig _policyContent.

auditIntervalSeconds

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

HubConfig auditIntervalSeconds.

constraintViolationLimit

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

HubConfig constraintViolationLimit.

deploymentConfigs

public deploymentConfigs: { [k: string]: google.cloud.gkehub.policycontroller.v1beta.IPolicyControllerDeploymentConfig };

HubConfig deploymentConfigs.

exemptableNamespaces

public exemptableNamespaces: string[];

HubConfig exemptableNamespaces.

installSpec

public installSpec: (google.cloud.gkehub.policycontroller.v1beta.HubConfig.InstallSpec|keyof typeof google.cloud.gkehub.policycontroller.v1beta.HubConfig.InstallSpec);

HubConfig installSpec.

logDeniesEnabled

public logDeniesEnabled: boolean;

HubConfig logDeniesEnabled.

monitoring

public monitoring?: (google.cloud.gkehub.policycontroller.v1beta.IMonitoringConfig|null);

HubConfig monitoring.

mutationEnabled

public mutationEnabled: boolean;

HubConfig mutationEnabled.

policyContent

public policyContent?: (google.cloud.gkehub.policycontroller.v1beta.IPolicyContentSpec|null);

HubConfig policyContent.

referentialRulesEnabled

public referentialRulesEnabled: boolean;

HubConfig referentialRulesEnabled.

Methods

create(properties)

public static create(properties?: google.cloud.gkehub.policycontroller.v1beta.IHubConfig): google.cloud.gkehub.policycontroller.v1beta.HubConfig;

Creates a new HubConfig instance using the specified properties.

Parameter
Name Description
properties IHubConfig

Properties to set

Returns
Type Description
HubConfig

HubConfig instance

decode(reader, length)

public static decode(reader: ($protobuf.Reader|Uint8Array), length?: number): google.cloud.gkehub.policycontroller.v1beta.HubConfig;

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

HubConfig

decodeDelimited(reader)

public static decodeDelimited(reader: ($protobuf.Reader|Uint8Array)): google.cloud.gkehub.policycontroller.v1beta.HubConfig;

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

Parameter
Name Description
reader (Reader|Uint8Array)

Reader or buffer to decode from

Returns
Type Description
HubConfig

HubConfig

encode(message, writer)

public static encode(message: google.cloud.gkehub.policycontroller.v1beta.IHubConfig, writer?: $protobuf.Writer): $protobuf.Writer;

Encodes the specified HubConfig message. Does not implicitly messages.

Parameters
Name Description
message IHubConfig

HubConfig 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.policycontroller.v1beta.IHubConfig, writer?: $protobuf.Writer): $protobuf.Writer;

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

Parameters
Name Description
message IHubConfig

HubConfig 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.policycontroller.v1beta.HubConfig;

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

HubConfig

getTypeUrl(typeUrlPrefix)

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

Gets the default type url for HubConfig

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

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

JSON object

toObject(message, options)

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

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

Parameters
Name Description
message HubConfig

HubConfig

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