Class protos.google.api.apikeys.v2.ApiKeys (1.2.0)

Represents an ApiKeys

Inheritance

$protobuf.rpc.Service > protos.google.api.apikeys.v2.ApiKeys

Package

Constructors

(constructor)(rpcImpl, requestDelimited, responseDelimited)

constructor(rpcImpl: $protobuf.RPCImpl, requestDelimited?: boolean, responseDelimited?: boolean);

Constructs a new ApiKeys service.

Parameters
Name	Description
`rpcImpl`	`$protobuf.RPCImpl` RPC implementation
`requestDelimited`	`boolean` Whether requests are length-delimited
`responseDelimited`	`boolean` Whether responses are length-delimited

Methods

create(rpcImpl, requestDelimited, responseDelimited)

public static create(rpcImpl: $protobuf.RPCImpl, requestDelimited?: boolean, responseDelimited?: boolean): ApiKeys;

Creates new ApiKeys service using the specified rpc implementation.

Parameters
Name	Description
`rpcImpl`	`$protobuf.RPCImpl` RPC implementation
`requestDelimited`	`boolean` Whether requests are length-delimited
`responseDelimited`	`boolean` Whether responses are length-delimited

Returns
Type	Description
`ApiKeys`	RPC service. Useful where requests and/or responses are streamed.

createKey(request, callback)

public createKey(request: google.api.apikeys.v2.ICreateKeyRequest, callback: google.api.apikeys.v2.ApiKeys.CreateKeyCallback): void;

Calls CreateKey.

Parameters
Name	Description
`request`	`ICreateKeyRequest` CreateKeyRequest message or plain object
`callback`	`CreateKeyCallback` Node-style callback called with the error, if any, and Operation

Returns
Type	Description
`void`

createKey(request)

public createKey(request: google.api.apikeys.v2.ICreateKeyRequest): Promise<google.longrunning.Operation>;

Calls CreateKey.

Parameter
Name	Description
`request`	`ICreateKeyRequest` CreateKeyRequest message or plain object

Returns
Type	Description
`Promise<google.longrunning.Operation>`	Promise

deleteKey(request, callback)

public deleteKey(request: google.api.apikeys.v2.IDeleteKeyRequest, callback: google.api.apikeys.v2.ApiKeys.DeleteKeyCallback): void;

Calls DeleteKey.

Parameters
Name	Description
`request`	`IDeleteKeyRequest` DeleteKeyRequest message or plain object
`callback`	`DeleteKeyCallback` Node-style callback called with the error, if any, and Operation

Returns
Type	Description
`void`

deleteKey(request)

public deleteKey(request: google.api.apikeys.v2.IDeleteKeyRequest): Promise<google.longrunning.Operation>;

Calls DeleteKey.

Parameter
Name	Description
`request`	`IDeleteKeyRequest` DeleteKeyRequest message or plain object

Returns
Type	Description
`Promise<google.longrunning.Operation>`	Promise

getKey(request, callback)

public getKey(request: google.api.apikeys.v2.IGetKeyRequest, callback: google.api.apikeys.v2.ApiKeys.GetKeyCallback): void;

Calls GetKey.

Parameters
Name	Description
`request`	`IGetKeyRequest` GetKeyRequest message or plain object
`callback`	`GetKeyCallback` Node-style callback called with the error, if any, and Key

Returns
Type	Description
`void`

getKey(request)

public getKey(request: google.api.apikeys.v2.IGetKeyRequest): Promise<google.api.apikeys.v2.Key>;

Calls GetKey.

Parameter
Name	Description
`request`	`IGetKeyRequest` GetKeyRequest message or plain object

Returns
Type	Description
`Promise<google.api.apikeys.v2.Key>`	Promise

getKeyString(request, callback)

public getKeyString(request: google.api.apikeys.v2.IGetKeyStringRequest, callback: google.api.apikeys.v2.ApiKeys.GetKeyStringCallback): void;

Calls GetKeyString.

Parameters
Name	Description
`request`	`IGetKeyStringRequest` GetKeyStringRequest message or plain object
`callback`	`GetKeyStringCallback` Node-style callback called with the error, if any, and GetKeyStringResponse

Returns
Type	Description
`void`

getKeyString(request)

public getKeyString(request: google.api.apikeys.v2.IGetKeyStringRequest): Promise<google.api.apikeys.v2.GetKeyStringResponse>;

Calls GetKeyString.

Parameter
Name	Description
`request`	`IGetKeyStringRequest` GetKeyStringRequest message or plain object

Returns
Type	Description
`Promise<google.api.apikeys.v2.GetKeyStringResponse>`	Promise

listKeys(request, callback)

public listKeys(request: google.api.apikeys.v2.IListKeysRequest, callback: google.api.apikeys.v2.ApiKeys.ListKeysCallback): void;

Calls ListKeys.

Parameters
Name	Description
`request`	`IListKeysRequest` ListKeysRequest message or plain object
`callback`	`ListKeysCallback` Node-style callback called with the error, if any, and ListKeysResponse

Returns
Type	Description
`void`

listKeys(request)

public listKeys(request: google.api.apikeys.v2.IListKeysRequest): Promise<google.api.apikeys.v2.ListKeysResponse>;

Calls ListKeys.

Parameter
Name	Description
`request`	`IListKeysRequest` ListKeysRequest message or plain object

Returns
Type	Description
`Promise<google.api.apikeys.v2.ListKeysResponse>`	Promise

lookupKey(request, callback)

public lookupKey(request: google.api.apikeys.v2.ILookupKeyRequest, callback: google.api.apikeys.v2.ApiKeys.LookupKeyCallback): void;

Calls LookupKey.

Parameters
Name	Description
`request`	`ILookupKeyRequest` LookupKeyRequest message or plain object
`callback`	`LookupKeyCallback` Node-style callback called with the error, if any, and LookupKeyResponse

Returns
Type	Description
`void`

lookupKey(request)

public lookupKey(request: google.api.apikeys.v2.ILookupKeyRequest): Promise<google.api.apikeys.v2.LookupKeyResponse>;

Calls LookupKey.

Parameter
Name	Description
`request`	`ILookupKeyRequest` LookupKeyRequest message or plain object

Returns
Type	Description
`Promise<google.api.apikeys.v2.LookupKeyResponse>`	Promise

undeleteKey(request, callback)

public undeleteKey(request: google.api.apikeys.v2.IUndeleteKeyRequest, callback: google.api.apikeys.v2.ApiKeys.UndeleteKeyCallback): void;

Calls UndeleteKey.

Parameters
Name	Description
`request`	`IUndeleteKeyRequest` UndeleteKeyRequest message or plain object
`callback`	`UndeleteKeyCallback` Node-style callback called with the error, if any, and Operation

Returns
Type	Description
`void`

undeleteKey(request)

public undeleteKey(request: google.api.apikeys.v2.IUndeleteKeyRequest): Promise<google.longrunning.Operation>;

Calls UndeleteKey.

Parameter
Name	Description
`request`	`IUndeleteKeyRequest` UndeleteKeyRequest message or plain object

Returns
Type	Description
`Promise<google.longrunning.Operation>`	Promise

updateKey(request, callback)

public updateKey(request: google.api.apikeys.v2.IUpdateKeyRequest, callback: google.api.apikeys.v2.ApiKeys.UpdateKeyCallback): void;

Calls UpdateKey.

Parameters
Name	Description
`request`	`IUpdateKeyRequest` UpdateKeyRequest message or plain object
`callback`	`UpdateKeyCallback` Node-style callback called with the error, if any, and Operation

Returns
Type	Description
`void`

updateKey(request)

public updateKey(request: google.api.apikeys.v2.IUpdateKeyRequest): Promise<google.longrunning.Operation>;

Calls UpdateKey.

Parameter
Name	Description
`request`	`IUpdateKeyRequest` UpdateKeyRequest message or plain object

Returns
Type	Description
`Promise<google.longrunning.Operation>`	Promise