Skip to main content

Class: GetApiKeyResponse

cloudservice.v1.GetApiKeyResponse

Represents a GetApiKeyResponse.

Implements

Constructors

constructor

new GetApiKeyResponse(properties?): GetApiKeyResponse

Constructs a new GetApiKeyResponse.

Parameters

NameTypeDescription
properties?IGetApiKeyResponseProperties to set

Returns

GetApiKeyResponse

Properties

apiKey

Optional apiKey: null | IApiKey

The api key.

Implementation of

IGetApiKeyResponse.apiKey

Methods

toJSON

toJSON(): Object

Converts this GetApiKeyResponse to JSON.

Returns

Object

JSON object


create

create(properties?): GetApiKeyResponse

Creates a new GetApiKeyResponse instance using the specified properties.

Parameters

NameTypeDescription
properties?IGetApiKeyResponseProperties to set

Returns

GetApiKeyResponse

GetApiKeyResponse instance


decode

decode(reader, length?): GetApiKeyResponse

Decodes a GetApiKeyResponse message from the specified reader or buffer.

Parameters

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

Returns

GetApiKeyResponse

GetApiKeyResponse

Throws

If the payload is not a reader or valid buffer

Throws

If required fields are missing


decodeDelimited

decodeDelimited(reader): GetApiKeyResponse

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

Parameters

NameTypeDescription
readerUint8Array | ReaderReader or buffer to decode from

Returns

GetApiKeyResponse

GetApiKeyResponse

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 GetApiKeyResponse message. Does not implicitly temporal.api.cloud.cloudservice.v1.GetApiKeyResponse.verify|verify messages.

Parameters

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

Returns

Writer

Writer


encodeDelimited

encodeDelimited(message, writer?): Writer

Encodes the specified GetApiKeyResponse message, length delimited. Does not implicitly temporal.api.cloud.cloudservice.v1.GetApiKeyResponse.verify|verify messages.

Parameters

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

Returns

Writer

Writer


fromObject

fromObject(object): GetApiKeyResponse

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

Parameters

NameTypeDescription
objectObjectPlain object

Returns

GetApiKeyResponse

GetApiKeyResponse


getTypeUrl

getTypeUrl(typeUrlPrefix?): string

Gets the default type url for GetApiKeyResponse

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 GetApiKeyResponse message. Also converts values to other types if specified.

Parameters

NameTypeDescription
messageGetApiKeyResponseGetApiKeyResponse
options?IConversionOptionsConversion options

Returns

Object

Plain object