Skip to main content

Class: ProviderValidationStatus

v1.ComputeStatus.ProviderValidationStatus

ProviderValidationStatus represents the result of the most recent connectivity check between Temporal and a customer's compute provider.

Implements

Constructors

constructor

new ProviderValidationStatus(properties?): ProviderValidationStatus

Constructs a new ProviderValidationStatus.

Parameters

NameTypeDescription
properties?IProviderValidationStatusProperties to set

Returns

ProviderValidationStatus

Properties

errorMessage

errorMessage: string

Human-readable error message if connectivity validation failed. An empty string means validation passed.

Implementation of

IProviderValidationStatus.errorMessage


lastCheckTime

Optional lastCheckTime: null | ITimestamp

Timestamp of the last validation check.

Implementation of

IProviderValidationStatus.lastCheckTime

Methods

toJSON

toJSON(): Object

Converts this ProviderValidationStatus to JSON.

Returns

Object

JSON object


create

create(properties?): ProviderValidationStatus

Creates a new ProviderValidationStatus instance using the specified properties.

Parameters

NameTypeDescription
properties?IProviderValidationStatusProperties to set

Returns

ProviderValidationStatus

ProviderValidationStatus instance


decode

decode(reader, length?): ProviderValidationStatus

Decodes a ProviderValidationStatus message from the specified reader or buffer.

Parameters

NameTypeDescription
readerUint8Array | ReaderReader or buffer to decode from
length?numberMessage length if known beforehand

Returns

ProviderValidationStatus

ProviderValidationStatus

Throws

If the payload is not a reader or valid buffer

Throws

If required fields are missing


decodeDelimited

decodeDelimited(reader): ProviderValidationStatus

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

Parameters

NameTypeDescription
readerUint8Array | ReaderReader or buffer to decode from

Returns

ProviderValidationStatus

ProviderValidationStatus

Throws

If the payload is not a reader or valid buffer

Throws

If required fields are missing


encode

encode(message, writer?): Writer

Encodes the specified ProviderValidationStatus message. Does not implicitly temporal.api.deployment.v1.ComputeStatus.ProviderValidationStatus.verify|verify messages.

Parameters

NameTypeDescription
messageIProviderValidationStatusProviderValidationStatus message or plain object to encode
writer?WriterWriter to encode to

Returns

Writer

Writer


encodeDelimited

encodeDelimited(message, writer?): Writer

Encodes the specified ProviderValidationStatus message, length delimited. Does not implicitly temporal.api.deployment.v1.ComputeStatus.ProviderValidationStatus.verify|verify messages.

Parameters

NameTypeDescription
messageIProviderValidationStatusProviderValidationStatus message or plain object to encode
writer?WriterWriter to encode to

Returns

Writer

Writer


fromObject

fromObject(object): ProviderValidationStatus

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

Parameters

NameTypeDescription
objectObjectPlain object

Returns

ProviderValidationStatus

ProviderValidationStatus


getTypeUrl

getTypeUrl(typeUrlPrefix?): string

Gets the default type url for ProviderValidationStatus

Parameters

NameTypeDescription
typeUrlPrefix?stringyour custom typeUrlPrefix(default "type.googleapis.com")

Returns

string

The default type url


toObject

toObject(message, options?): Object

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

Parameters

NameTypeDescription
messageProviderValidationStatusProviderValidationStatus
options?IConversionOptionsConversion options

Returns

Object

Plain object