Class protos.google.cloud.gkehub.configmanagement.v1.MembershipSpec (1.2.1)

Represents a MembershipSpec.

Package

@google-cloud/gke-hub!

Constructors

(constructor)(properties)

constructor(properties?: google.cloud.gkehub.configmanagement.v1.IMembershipSpec);

Constructs a new MembershipSpec.

Parameter
NameDescription
properties IMembershipSpec

Properties to set

Properties

configSync

public configSync?: (google.cloud.gkehub.configmanagement.v1.IConfigSync|null);

MembershipSpec configSync.

Property Value
TypeDescription
(google.cloud.gkehub.configmanagement.v1.IConfigSync|null)

hierarchyController

public hierarchyController?: (google.cloud.gkehub.configmanagement.v1.IHierarchyControllerConfig|null);

MembershipSpec hierarchyController.

Property Value
TypeDescription
(google.cloud.gkehub.configmanagement.v1.IHierarchyControllerConfig|null)

policyController

public policyController?: (google.cloud.gkehub.configmanagement.v1.IPolicyController|null);

MembershipSpec policyController.

Property Value
TypeDescription
(google.cloud.gkehub.configmanagement.v1.IPolicyController|null)

version

public version: string;

MembershipSpec version.

Property Value
TypeDescription
string

Methods

create(properties)

public static create(properties?: google.cloud.gkehub.configmanagement.v1.IMembershipSpec): google.cloud.gkehub.configmanagement.v1.MembershipSpec;

Creates a new MembershipSpec instance using the specified properties.

Parameter
NameDescription
properties IMembershipSpec

Properties to set

Returns
TypeDescription
google.cloud.gkehub.configmanagement.v1.MembershipSpec

MembershipSpec instance

decode(reader, length)

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

Decodes a MembershipSpec message from the specified reader or buffer.

Parameters
NameDescription
reader ($protobuf.Reader|Uint8Array)

Reader or buffer to decode from

length number

Message length if known beforehand

Returns
TypeDescription
google.cloud.gkehub.configmanagement.v1.MembershipSpec

MembershipSpec

decodeDelimited(reader)

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

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

Parameter
NameDescription
reader ($protobuf.Reader|Uint8Array)

Reader or buffer to decode from

Returns
TypeDescription
google.cloud.gkehub.configmanagement.v1.MembershipSpec

MembershipSpec

encode(message, writer)

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

Encodes the specified MembershipSpec message. Does not implicitly messages.

Parameters
NameDescription
message IMembershipSpec

MembershipSpec message or plain object to encode

writer $protobuf.Writer

Writer to encode to

Returns
TypeDescription
$protobuf.Writer

Writer

encodeDelimited(message, writer)

public static encodeDelimited(message: google.cloud.gkehub.configmanagement.v1.IMembershipSpec, writer?: $protobuf.Writer): $protobuf.Writer;

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

Parameters
NameDescription
message IMembershipSpec

MembershipSpec message or plain object to encode

writer $protobuf.Writer

Writer to encode to

Returns
TypeDescription
$protobuf.Writer

Writer

fromObject(object)

public static fromObject(object: { [k: string]: any }): google.cloud.gkehub.configmanagement.v1.MembershipSpec;

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

Parameter
NameDescription
object { [k: string]: any }

Plain object

Returns
TypeDescription
google.cloud.gkehub.configmanagement.v1.MembershipSpec

MembershipSpec

toJSON()

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

Converts this MembershipSpec to JSON.

Returns
TypeDescription
{ [k: string]: any }

JSON object

toObject(message, options)

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

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

Parameters
NameDescription
message google.cloud.gkehub.configmanagement.v1.MembershipSpec

MembershipSpec

options $protobuf.IConversionOptions

Conversion options

Returns
TypeDescription
{ [k: string]: any }

Plain object

verify(message)

public static verify(message: { [k: string]: any }): (string|null);

Verifies a MembershipSpec message.

Parameter
NameDescription
message { [k: string]: any }

Plain object to verify

Returns
TypeDescription
(string|null)

null if valid, otherwise the reason why it is not