Class protos.google.cloud.gkehub.v1alpha2.Membership (1.4.0)

Represents a Membership.

Package

@google-cloud/gke-hub

Constructors

(constructor)(properties)

constructor(properties?: google.cloud.gkehub.v1alpha2.IMembership);

Constructs a new Membership.

Parameter
Name Description
properties IMembership

Properties to set

Properties

authority

public authority?: (google.cloud.gkehub.v1alpha2.IAuthority|null);

Membership authority.

createTime

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

Membership createTime.

deleteTime

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

Membership deleteTime.

description

public description: string;

Membership description.

endpoint

public endpoint?: (google.cloud.gkehub.v1alpha2.IMembershipEndpoint|null);

Membership endpoint.

externalId

public externalId: string;

Membership externalId.

infrastructureType

public infrastructureType: (google.cloud.gkehub.v1alpha2.Membership.InfrastructureType|keyof typeof google.cloud.gkehub.v1alpha2.Membership.InfrastructureType);

Membership infrastructureType.

labels

public labels: { [k: string]: string };

Membership labels.

lastConnectionTime

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

Membership lastConnectionTime.

name

public name: string;

Membership name.

state

public state?: (google.cloud.gkehub.v1alpha2.IMembershipState|null);

Membership state.

type

public type?: "endpoint";

Membership type.

uniqueId

public uniqueId: string;

Membership uniqueId.

updateTime

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

Membership updateTime.

Methods

create(properties)

public static create(properties?: google.cloud.gkehub.v1alpha2.IMembership): google.cloud.gkehub.v1alpha2.Membership;

Creates a new Membership instance using the specified properties.

Parameter
Name Description
properties IMembership

Properties to set
Returns
Type Description
google.cloud.gkehub.v1alpha2.Membership

Membership instance

decode(reader, length)

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

Decodes a Membership 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.v1alpha2.Membership

Membership

decodeDelimited(reader)

public static decodeDelimited(reader: ($protobuf.Reader|Uint8Array)): google.cloud.gkehub.v1alpha2.Membership;

Decodes a Membership 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.v1alpha2.Membership

Membership

encode(message, writer)

public static encode(message: google.cloud.gkehub.v1alpha2.IMembership, writer?: $protobuf.Writer): $protobuf.Writer;

Encodes the specified Membership message. Does not implicitly messages.

Parameters
Name Description
message IMembership

Membership 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.v1alpha2.IMembership, writer?: $protobuf.Writer): $protobuf.Writer;

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

Parameters
Name Description
message IMembership

Membership 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.v1alpha2.Membership;

Creates a Membership 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.v1alpha2.Membership

Membership

toJSON()

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

Converts this Membership to JSON.

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

JSON object

toObject(message, options)

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

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

Parameters
Name Description
message google.cloud.gkehub.v1alpha2.Membership

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