Class ApiKeysGrpc.ApiKeysBlockingStub (0.22.0)

public static final class ApiKeysGrpc.ApiKeysBlockingStub extends AbstractBlockingStub<ApiKeysGrpc.ApiKeysBlockingStub>

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

Manages the API keys associated with projects.

Inheritance

java.lang.Object > io.grpc.stub.AbstractStub > io.grpc.stub.AbstractBlockingStub > ApiKeysGrpc.ApiKeysBlockingStub

Inherited Members

io.grpc.stub.AbstractBlockingStub.<T>newStub(io.grpc.stub.AbstractStub.StubFactory<T>,io.grpc.Channel)

io.grpc.stub.AbstractBlockingStub.<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()

Object.clone()

Object.equals(Object)

Object.finalize()

Object.getClass()

Object.hashCode()

Object.notify()

Object.notifyAll()

Object.toString()

Object.wait()

Object.wait(long)

Object.wait(long,int)

Methods

build(Channel channel, CallOptions callOptions)

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

Parameters
Name	Description
`channel`	`io.grpc.Channel`
`callOptions`	`io.grpc.CallOptions`

Returns
Type	Description
`ApiKeysGrpc.ApiKeysBlockingStub`

Overrides

io.grpc.stub.AbstractStub.build(io.grpc.Channel,io.grpc.CallOptions)

createKey(CreateKeyRequest request)

public 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
Name	Description
`request`	`CreateKeyRequest`

Returns
Type	Description
`Operation`

deleteKey(DeleteKeyRequest request)

public 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
Name	Description
`request`	`DeleteKeyRequest`

Returns
Type	Description
`Operation`

getKey(GetKeyRequest request)

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.

Parameter
Name	Description
`request`	`GetKeyRequest`

Returns
Type	Description
`Key`

getKeyString(GetKeyStringRequest request)

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.

Parameter
Name	Description
`request`	`GetKeyStringRequest`

Returns
Type	Description
`GetKeyStringResponse`

listKeys(ListKeysRequest request)

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.

Parameter
Name	Description
`request`	`ListKeysRequest`

Returns
Type	Description
`ListKeysResponse`

lookupKey(LookupKeyRequest request)

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.

Parameter
Name	Description
`request`	`LookupKeyRequest`

Returns
Type	Description
`LookupKeyResponse`

undeleteKey(UndeleteKeyRequest request)

public 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
Name	Description
`request`	`UndeleteKeyRequest`

Returns
Type	Description
`Operation`

updateKey(UpdateKeyRequest request)

public 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
Name	Description
`request`	`UpdateKeyRequest`

Returns
Type	Description
`Operation`