public static final class ApiKeysGrpc.ApiKeysStub extends AbstractAsyncStub<ApiKeysGrpc.ApiKeysStub>
Manages the API keys associated with projects.
Inheritance
java.lang.Object >
io.grpc.stub.AbstractStub >
io.grpc.stub.AbstractAsyncStub >
ApiKeysGrpc.ApiKeysStub
Inherited Members
io.grpc.stub.AbstractAsyncStub.<T>newStub(io.grpc.stub.AbstractStub.StubFactory<T>,io.grpc.Channel)
io.grpc.stub.AbstractAsyncStub.<T>newStub(io.grpc.stub.AbstractStub.StubFactory<T>,io.grpc.Channel,io.grpc.CallOptions)
io.grpc.stub.AbstractStub.<T>withOption(io.grpc.CallOptions.Key<T>,T)
io.grpc.stub.AbstractStub.build(io.grpc.Channel,io.grpc.CallOptions)
io.grpc.stub.AbstractStub.getCallOptions()
io.grpc.stub.AbstractStub.getChannel()
io.grpc.stub.AbstractStub.withCallCredentials(io.grpc.CallCredentials)
io.grpc.stub.AbstractStub.withChannel(io.grpc.Channel)
io.grpc.stub.AbstractStub.withCompression(java.lang.String)
io.grpc.stub.AbstractStub.withDeadline(io.grpc.Deadline)
io.grpc.stub.AbstractStub.withDeadlineAfter(long,java.util.concurrent.TimeUnit)
io.grpc.stub.AbstractStub.withExecutor(java.util.concurrent.Executor)
io.grpc.stub.AbstractStub.withInterceptors(io.grpc.ClientInterceptor...)
io.grpc.stub.AbstractStub.withMaxInboundMessageSize(int)
io.grpc.stub.AbstractStub.withMaxOutboundMessageSize(int)
io.grpc.stub.AbstractStub.withWaitForReady()
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
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
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
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
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
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
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
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