Class protos.google.cloud.gkehub.configmanagement.v1.MembershipState (1.3.0)

Represents a MembershipState.

Package

@google-cloud/gke-hub!

Constructors

(constructor)(properties)

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

Constructs a new MembershipState.

Parameter

Name	Description
properties	`IMembershipState` Properties to set

Properties

clusterName

public clusterName: string;

MembershipState clusterName.

Property Value

Type	Description
string

configSyncState

public configSyncState?: (google.cloud.gkehub.configmanagement.v1.IConfigSyncState|null);

MembershipState configSyncState.

Property Value

Type	Description
(google.cloud.gkehub.configmanagement.v1.IConfigSyncState\|null)

hierarchyControllerState

public hierarchyControllerState?: (google.cloud.gkehub.configmanagement.v1.IHierarchyControllerState|null);

MembershipState hierarchyControllerState.

Property Value

Type	Description
(google.cloud.gkehub.configmanagement.v1.IHierarchyControllerState\|null)

membershipSpec

public membershipSpec?: (google.cloud.gkehub.configmanagement.v1.IMembershipSpec|null);

MembershipState membershipSpec.

Property Value

Type	Description
(google.cloud.gkehub.configmanagement.v1.IMembershipSpec\|null)

operatorState

public operatorState?: (google.cloud.gkehub.configmanagement.v1.IOperatorState|null);

MembershipState operatorState.

Property Value

Type	Description
(google.cloud.gkehub.configmanagement.v1.IOperatorState\|null)

policyControllerState

public policyControllerState?: (google.cloud.gkehub.configmanagement.v1.IPolicyControllerState|null);

MembershipState policyControllerState.

Property Value

Type	Description
(google.cloud.gkehub.configmanagement.v1.IPolicyControllerState\|null)

Methods

create(properties)

public static create(properties?: google.cloud.gkehub.configmanagement.v1.IMembershipState): google.cloud.gkehub.configmanagement.v1.MembershipState;

Creates a new MembershipState instance using the specified properties.

Parameter

Name	Description
properties	`IMembershipState` Properties to set

Returns

Type	Description
google.cloud.gkehub.configmanagement.v1.MembershipState	MembershipState instance

decode(reader, length)

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

Decodes a MembershipState 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.gkehub.configmanagement.v1.MembershipState	MembershipState

decodeDelimited(reader)

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

Decodes a MembershipState 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.gkehub.configmanagement.v1.MembershipState	MembershipState

encode(message, writer)

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

Encodes the specified MembershipState message. Does not implicitly messages.

Parameters

Name	Description
message	`IMembershipState` MembershipState 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.v1.IMembershipState, writer?: $protobuf.Writer): $protobuf.Writer;

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

Parameters

Name	Description
message	`IMembershipState` MembershipState 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.v1.MembershipState;

Creates a MembershipState 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.gkehub.configmanagement.v1.MembershipState	MembershipState

toJSON()

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

Converts this MembershipState to JSON.

Returns

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

toObject(message, options)

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

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

Parameters

Name	Description
message	`google.cloud.gkehub.configmanagement.v1.MembershipState` MembershipState
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 MembershipState 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