Package com.google.api.apikeys.v2

Class ApiKeysGrpc.ApiKeysBlockingStub

java.lang.Object

io.grpc.stub.AbstractStub<S>

io.grpc.stub.AbstractBlockingStub<ApiKeysGrpc.ApiKeysBlockingStub>

com.google.api.apikeys.v2.ApiKeysGrpc.ApiKeysBlockingStub

Enclosing class:

ApiKeysGrpc

public static final class ApiKeysGrpc.ApiKeysBlockingStub
extends io.grpc.stub.AbstractBlockingStub<ApiKeysGrpc.ApiKeysBlockingStub>

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

 Manages the API keys associated with projects.
 

Nested Class Summary

Nested classes/interfaces inherited from class io.grpc.stub.AbstractStub

io.grpc.stub.AbstractStub.StubFactory<T extends io.grpc.stub.AbstractStub<T>>

Method Summary

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

Methods inherited from class io.grpc.stub.AbstractBlockingStub

newStub, newStub

Methods inherited from class io.grpc.stub.AbstractStub

getCallOptions, getChannel, withCallCredentials, withChannel, withCompression, withDeadline, withDeadlineAfter, withExecutor, withInterceptors, withMaxInboundMessageSize, withMaxOutboundMessageSize, withOption, withWaitForReady

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

build

protected ApiKeysGrpc.ApiKeysBlockingStub build(io.grpc.Channel channel,
                                                io.grpc.CallOptions callOptions)

Specified by:

build in class io.grpc.stub.AbstractStub<ApiKeysGrpc.ApiKeysBlockingStub>

createKey

public com.google.longrunning.Operation createKey(CreateKeyRequest request)

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

listKeys

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

getKey

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

getKeyString

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

updateKey

public com.google.longrunning.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`.
 

deleteKey

public com.google.longrunning.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`.
 

undeleteKey

public com.google.longrunning.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`.
 

lookupKey

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