Class protos.google.cloud.gkehub.v1.Membership (1.3.0)

Version 1.3.0

• 4.2.0 (latest)
• 3.4.0
• 3.3.1
• 3.2.2
• 2.2.0
• 2.1.0
• 2.0.0
• 1.4.0
• 1.3.0
• 1.2.1
• 1.1.4

Represents a Membership.

Package

@google-cloud/gke-hub!

Constructors

(constructor)(properties)

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

Constructs a new Membership.

Parameter

Name	Description
properties	IMembership Properties to set

Properties

authority

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

Membership authority.

Property Value

Type	Description
(google.cloud.gkehub.v1.IAuthority|null)

createTime

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

Membership createTime.

Property Value

Type	Description
(google.protobuf.ITimestamp|null)

deleteTime

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

Membership deleteTime.

Property Value

Type	Description
(google.protobuf.ITimestamp|null)

description

public description: string;

Membership description.

Property Value

Type	Description
string

endpoint

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

Membership endpoint.

Property Value

Type	Description
(google.cloud.gkehub.v1.IMembershipEndpoint|null)

externalId

public externalId: string;

Membership externalId.

Property Value

Type	Description
string

labels

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

Membership labels.

Property Value

Type	Description
{ [k: string]: string }

lastConnectionTime

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

Membership lastConnectionTime.

Property Value

Type	Description
(google.protobuf.ITimestamp|null)

name

public name: string;

Membership name.

Property Value

Type	Description
string

state

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

Membership state.

Property Value

Type	Description
(google.cloud.gkehub.v1.IMembershipState|null)

type

public type?: "endpoint";

Membership type.

Property Value

Type	Description
"endpoint"

uniqueId

public uniqueId: string;

Membership uniqueId.

Property Value

Type	Description
string

updateTime

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

Membership updateTime.

Property Value

Type	Description
(google.protobuf.ITimestamp|null)

Methods

create(properties)

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

Creates a new Membership instance using the specified properties.

Parameter

Name	Description
properties	IMembership Properties to set

Returns

Type	Description
google.cloud.gkehub.v1.Membership	Membership instance

decode(reader, length)

public static decode(reader: ($protobuf.Reader|Uint8Array), length?: number): google.cloud.gkehub.v1.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.v1.Membership	Membership

decodeDelimited(reader)

public static decodeDelimited(reader: ($protobuf.Reader|Uint8Array)): google.cloud.gkehub.v1.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.v1.Membership	Membership

encode(message, writer)

public static encode(message: google.cloud.gkehub.v1.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.v1.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.v1.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.v1.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.v1.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.v1.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