Class ApiKeysGrpc.ApiKeysStub (0.41.0)

public static final class ApiKeysGrpc.ApiKeysStub extends AbstractAsyncStub<ApiKeysGrpc.ApiKeysStub>

A stub to allow clients to do asynchronous rpc calls to service ApiKeys.

Manages the API keys associated with projects.

Inheritance

java.lang.Object > io.grpc.stub.AbstractStub > io.grpc.stub.AbstractAsyncStub > ApiKeysGrpc.ApiKeysStub

Methods

build(Channel channel, CallOptions callOptions)

protected ApiKeysGrpc.ApiKeysStub build(Channel channel, CallOptions callOptions)
Parameters
Name Description
channel io.grpc.Channel
callOptions io.grpc.CallOptions
Returns
Type Description
ApiKeysGrpc.ApiKeysStub
Overrides
io.grpc.stub.AbstractStub.build(io.grpc.Channel,io.grpc.CallOptions)

createKey(CreateKeyRequest request, StreamObserver<Operation> responseObserver)

public 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 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 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 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 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 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 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 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>