ApiKeysClient class

Manages the API keys associated with projects.

Annotations
  • @GrpcServiceName.new('google.api.apikeys.v2.ApiKeys')

Constructors

ApiKeysClient(ClientChannel channel, {CallOptions? options, Iterable<ClientInterceptor>? interceptors})

Properties

hashCode → int
The hash code for this object.
no setterinherited
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited

Methods

$createCall<Q, R>(ClientMethod<Q, R> method, Stream<Q> requests, {CallOptions? options}) → ClientCall<Q, R>
inherited
$createStreamingCall<Q, R>(ClientMethod<Q, R> method, Stream<Q> requests, {CallOptions? options}) → ResponseStream<R>
inherited
$createUnaryCall<Q, R>(ClientMethod<Q, R> method, Q request, {CallOptions? options}) → ResponseFuture<R>
inherited
createKey(CreateKeyRequest request, {CallOptions? options}) → ResponseFuture<Operation>
Creates a new API key.
deleteKey(DeleteKeyRequest request, {CallOptions? options}) → ResponseFuture<Operation>
Deletes an API key. Deleted key can be retrieved within 30 days of deletion. Afterward, key will be purged from the project.
getKey(GetKeyRequest request, {CallOptions? options}) → ResponseFuture<Key>
Gets the metadata for an API key. The key string of the API key isn't included in the response.
getKeyString(GetKeyStringRequest request, {CallOptions? options}) → ResponseFuture<GetKeyStringResponse>
Get the key string for an API key.
listKeys(ListKeysRequest request, {CallOptions? options}) → ResponseFuture<ListKeysResponse>
Lists the API keys owned by a project. The key string of the API key isn't included in the response.
lookupKey(LookupKeyRequest request, {CallOptions? options}) → ResponseFuture<LookupKeyResponse>
Find the parent project and resource name of the API key that matches the key string in the request. If the API key has been purged, resource name will not be set. The service account must have the apikeys.keys.lookup permission on the parent project.
noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
toString() → String
A string representation of this object.
inherited
undeleteKey(UndeleteKeyRequest request, {CallOptions? options}) → ResponseFuture<Operation>
Undeletes an API key which was deleted within 30 days.
updateKey(UpdateKeyRequest request, {CallOptions? options}) → ResponseFuture<Operation>
Patches the modifiable fields of an API key. The key string of the API key isn't included in the response.

Operators

operator ==(Object other) → bool
The equality operator.
inherited

Constants

defaultHost → const String
The hostname for this service.
oauthScopes → const List<String>
OAuth scopes needed for the client.