Interface ApiKeysGrpc.AsyncService (0.47.0)

public static interface ApiKeysGrpc.AsyncService

Manages the API keys associated with projects.

Methods

createKey(CreateKeyRequest request, StreamObserver<Operation> responseObserver)

public default void createKey(CreateKeyRequest request, StreamObserver<Operation> responseObserver)

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

Parameters
Name	Description
`request`	`CreateKeyRequest`
`responseObserver`	`io.grpc.stub.StreamObserver<Operation>`

deleteKey(DeleteKeyRequest request, StreamObserver<Operation> responseObserver)

public default void deleteKey(DeleteKeyRequest request, StreamObserver<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.

Parameters
Name	Description
`request`	`DeleteKeyRequest`
`responseObserver`	`io.grpc.stub.StreamObserver<Operation>`

getKey(GetKeyRequest request, StreamObserver<Key> responseObserver)

public default void getKey(GetKeyRequest request, 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.

Parameters
Name	Description
`request`	`GetKeyRequest`
`responseObserver`	`io.grpc.stub.StreamObserver<Key>`

getKeyString(GetKeyStringRequest request, StreamObserver<GetKeyStringResponse> responseObserver)

public default void getKeyString(GetKeyStringRequest request, 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.

Parameters
Name	Description
`request`	`GetKeyStringRequest`
`responseObserver`	`io.grpc.stub.StreamObserver<GetKeyStringResponse>`

listKeys(ListKeysRequest request, StreamObserver<ListKeysResponse> responseObserver)

public default void listKeys(ListKeysRequest request, 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.

Parameters
Name	Description
`request`	`ListKeysRequest`
`responseObserver`	`io.grpc.stub.StreamObserver<ListKeysResponse>`

lookupKey(LookupKeyRequest request, StreamObserver<LookupKeyResponse> responseObserver)

public default void lookupKey(LookupKeyRequest request, 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.

Parameters
Name	Description
`request`	`LookupKeyRequest`
`responseObserver`	`io.grpc.stub.StreamObserver<LookupKeyResponse>`

undeleteKey(UndeleteKeyRequest request, StreamObserver<Operation> responseObserver)

public default void undeleteKey(UndeleteKeyRequest request, StreamObserver<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.

Parameters
Name	Description
`request`	`UndeleteKeyRequest`
`responseObserver`	`io.grpc.stub.StreamObserver<Operation>`

updateKey(UpdateKeyRequest request, StreamObserver<Operation> responseObserver)

public default void updateKey(UpdateKeyRequest request, StreamObserver<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.

Parameters
Name	Description
`request`	`UpdateKeyRequest`
`responseObserver`	`io.grpc.stub.StreamObserver<Operation>`