Class ApiKeysGrpc.ApiKeysFutureStub (0.37.0)

public static final class ApiKeysGrpc.ApiKeysFutureStub extends AbstractFutureStub<ApiKeysGrpc.ApiKeysFutureStub>

A stub to allow clients to do ListenableFuture-style rpc calls to service ApiKeys.

Manages the API keys associated with projects.

Inheritance

java.lang.Object > io.grpc.stub.AbstractStub > io.grpc.stub.AbstractFutureStub > ApiKeysGrpc.ApiKeysFutureStub

Methods

build(Channel channel, CallOptions callOptions)

protected ApiKeysGrpc.ApiKeysFutureStub build(Channel channel, CallOptions callOptions)
Parameters
NameDescription
channelio.grpc.Channel
callOptionsio.grpc.CallOptions
Returns
TypeDescription
ApiKeysGrpc.ApiKeysFutureStub
Overrides
io.grpc.stub.AbstractStub.build(io.grpc.Channel,io.grpc.CallOptions)

createKey(CreateKeyRequest request)

public ListenableFuture<Operation> createKey(CreateKeyRequest request)

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

Parameter
NameDescription
requestCreateKeyRequest
Returns
TypeDescription
com.google.common.util.concurrent.ListenableFuture<Operation>

deleteKey(DeleteKeyRequest request)

public ListenableFuture<Operation> deleteKey(DeleteKeyRequest request)

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.

Parameter
NameDescription
requestDeleteKeyRequest
Returns
TypeDescription
com.google.common.util.concurrent.ListenableFuture<Operation>

getKey(GetKeyRequest request)

public ListenableFuture<Key> getKey(GetKeyRequest request)

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.

Parameter
NameDescription
requestGetKeyRequest
Returns
TypeDescription
com.google.common.util.concurrent.ListenableFuture<Key>

getKeyString(GetKeyStringRequest request)

public ListenableFuture<GetKeyStringResponse> getKeyString(GetKeyStringRequest request)

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

Parameter
NameDescription
requestGetKeyStringRequest
Returns
TypeDescription
com.google.common.util.concurrent.ListenableFuture<GetKeyStringResponse>

listKeys(ListKeysRequest request)

public ListenableFuture<ListKeysResponse> listKeys(ListKeysRequest request)

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.

Parameter
NameDescription
requestListKeysRequest
Returns
TypeDescription
com.google.common.util.concurrent.ListenableFuture<ListKeysResponse>

lookupKey(LookupKeyRequest request)

public ListenableFuture<LookupKeyResponse> lookupKey(LookupKeyRequest request)

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.

Parameter
NameDescription
requestLookupKeyRequest
Returns
TypeDescription
com.google.common.util.concurrent.ListenableFuture<LookupKeyResponse>

undeleteKey(UndeleteKeyRequest request)

public ListenableFuture<Operation> undeleteKey(UndeleteKeyRequest request)

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.

Parameter
NameDescription
requestUndeleteKeyRequest
Returns
TypeDescription
com.google.common.util.concurrent.ListenableFuture<Operation>

updateKey(UpdateKeyRequest request)

public ListenableFuture<Operation> updateKey(UpdateKeyRequest request)

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.

Parameter
NameDescription
requestUpdateKeyRequest
Returns
TypeDescription
com.google.common.util.concurrent.ListenableFuture<Operation>