Class protos.google.cloud.gkehub.configmanagement.v1alpha.SyncState (4.5.0)

Represents a SyncState.

Package

@google-cloud/gke-hub

Constructors

(constructor)(properties)

constructor(properties?: google.cloud.gkehub.configmanagement.v1alpha.ISyncState);

Constructs a new SyncState.

Parameter
Name Description
properties ISyncState

Properties to set

Properties

code

public code: (google.cloud.gkehub.configmanagement.v1alpha.SyncState.SyncCode|keyof typeof google.cloud.gkehub.configmanagement.v1alpha.SyncState.SyncCode);

SyncState code.

errors

public errors: google.cloud.gkehub.configmanagement.v1alpha.ISyncError[];

SyncState errors.

importToken

public importToken: string;

SyncState importToken.

lastSync

public lastSync: string;

SyncState lastSync.

lastSyncTime

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

SyncState lastSyncTime.

sourceToken

public sourceToken: string;

SyncState sourceToken.

syncToken

public syncToken: string;

SyncState syncToken.

Methods

create(properties)

public static create(properties?: google.cloud.gkehub.configmanagement.v1alpha.ISyncState): google.cloud.gkehub.configmanagement.v1alpha.SyncState;

Creates a new SyncState instance using the specified properties.

Parameter
Name Description
properties ISyncState

Properties to set

Returns
Type Description
SyncState

SyncState instance

decode(reader, length)

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

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

SyncState

decodeDelimited(reader)

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

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

Parameter
Name Description
reader (Reader|Uint8Array)

Reader or buffer to decode from

Returns
Type Description
SyncState

SyncState

encode(message, writer)

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

Encodes the specified SyncState message. Does not implicitly messages.

Parameters
Name Description
message ISyncState

SyncState 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.v1alpha.ISyncState, writer?: $protobuf.Writer): $protobuf.Writer;

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

Parameters
Name Description
message ISyncState

SyncState 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.v1alpha.SyncState;

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

SyncState

getTypeUrl(typeUrlPrefix)

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

Gets the default type url for SyncState

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

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

JSON object

toObject(message, options)

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

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

Parameters
Name Description
message SyncState

SyncState

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