com.google.api.apikeys.v2

Interface ApiKeysGrpc.AsyncService

All Known Implementing Classes:

ApiKeysGrpc.ApiKeysImplBase

Enclosing class:

ApiKeysGrpc

public static interface ApiKeysGrpc.AsyncService

 Manages the API keys associated with projects.
 

Method Summary

Modifier and Type	Method and Description
default void	createKey(CreateKeyRequest request, io.grpc.stub.StreamObserver<com.google.longrunning.Operation> responseObserver) Creates a new API key.
default void	deleteKey(DeleteKeyRequest request, io.grpc.stub.StreamObserver<com.google.longrunning.Operation> responseObserver) Deletes an API key.
default void	getKey(GetKeyRequest request, io.grpc.stub.StreamObserver<Key> responseObserver) Gets the metadata for an API key.
default void	getKeyString(GetKeyStringRequest request, io.grpc.stub.StreamObserver<GetKeyStringResponse> responseObserver) Get the key string for an API key.
default void	listKeys(ListKeysRequest request, io.grpc.stub.StreamObserver<ListKeysResponse> responseObserver) Lists the API keys owned by a project.
default void	lookupKey(LookupKeyRequest request, io.grpc.stub.StreamObserver<LookupKeyResponse> responseObserver) Find the parent project and resource name of the API key that matches the key string in the request.
default void	undeleteKey(UndeleteKeyRequest request, io.grpc.stub.StreamObserver<com.google.longrunning.Operation> responseObserver) Undeletes an API key which was deleted within 30 days.
default void	updateKey(UpdateKeyRequest request, io.grpc.stub.StreamObserver<com.google.longrunning.Operation> responseObserver) Patches the modifiable fields of an API key.

Method Detail

createKey

default void createKey(CreateKeyRequest request,
                       io.grpc.stub.StreamObserver<com.google.longrunning.Operation> responseObserver)

 Creates a new API key.
 NOTE: Key is a global resource; hence the only supported value for
 location is `global`.
 

listKeys

default void listKeys(ListKeysRequest request,
                      io.grpc.stub.StreamObserver<ListKeysResponse> responseObserver)

 Lists the API keys owned by a project. The key string of the API key
 isn't included in the response.
 NOTE: Key is a global resource; hence the only supported value for
 location is `global`.
 

getKey

default void getKey(GetKeyRequest request,
                    io.grpc.stub.StreamObserver<Key> responseObserver)

 Gets the metadata for an API key. The key string of the API key
 isn't included in the response.
 NOTE: Key is a global resource; hence the only supported value for
 location is `global`.
 

getKeyString

default void getKeyString(GetKeyStringRequest request,
                          io.grpc.stub.StreamObserver<GetKeyStringResponse> responseObserver)

 Get the key string for an API key.
 NOTE: Key is a global resource; hence the only supported value for
 location is `global`.
 

updateKey

default void updateKey(UpdateKeyRequest request,
                       io.grpc.stub.StreamObserver<com.google.longrunning.Operation> responseObserver)

 Patches the modifiable fields of an API key.
 The key string of the API key isn't included in the response.
 NOTE: Key is a global resource; hence the only supported value for
 location is `global`.
 

deleteKey

default void deleteKey(DeleteKeyRequest request,
                       io.grpc.stub.StreamObserver<com.google.longrunning.Operation> responseObserver)

 Deletes an API key. Deleted key can be retrieved within 30 days of
 deletion. Afterward, key will be purged from the project.
 NOTE: Key is a global resource; hence the only supported value for
 location is `global`.
 

undeleteKey

default void undeleteKey(UndeleteKeyRequest request,
                         io.grpc.stub.StreamObserver<com.google.longrunning.Operation> responseObserver)

 Undeletes an API key which was deleted within 30 days.
 NOTE: Key is a global resource; hence the only supported value for
 location is `global`.
 

lookupKey

default void lookupKey(LookupKeyRequest request,
                       io.grpc.stub.StreamObserver<LookupKeyResponse> responseObserver)

 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.