Class ApiKeysClient (0.43.0)

GitHub RepositoryProduct Reference

Service Description: Manages the API keys associated with projects.

This class provides the ability to make remote calls to the backing service through method calls that map to API methods. Sample code to get started:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (ApiKeysClient apiKeysClient = ApiKeysClient.create()) {
   KeyName name = KeyName.of("[PROJECT]", "[LOCATION]", "[KEY]");
   Key response = apiKeysClient.getKey(name);
 }

Note: close() needs to be called on the ApiKeysClient object to clean up resources such as threads. In the example above, try-with-resources is used, which automatically calls close().

Methods
Method Description Method Variants

CreateKey

Creates a new API key.

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

Request object method variants only take one parameter, a request object, which must be constructed before the call.

  • createKeyAsync(CreateKeyRequest request)

Methods that return long-running operations have "Async" method variants that return OperationFuture, which is used to track polling of the service.

  • createKeyAsync(LocationName parent, Key key, String keyId)

  • createKeyAsync(String parent, Key key, String keyId)

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

  • createKeyOperationCallable()

  • createKeyCallable()

ListKeys

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.

Request object method variants only take one parameter, a request object, which must be constructed before the call.

  • listKeys(ListKeysRequest request)

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

  • listKeys(LocationName parent)

  • listKeys(String parent)

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

  • listKeysPagedCallable()

  • listKeysCallable()

GetKey

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.

Request object method variants only take one parameter, a request object, which must be constructed before the call.

  • getKey(GetKeyRequest request)

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

  • getKey(KeyName name)

  • getKey(String name)

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

  • getKeyCallable()

GetKeyString

Get the key string for an API key.

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

Request object method variants only take one parameter, a request object, which must be constructed before the call.

  • getKeyString(GetKeyStringRequest request)

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

  • getKeyString(KeyName name)

  • getKeyString(String name)

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

  • getKeyStringCallable()

UpdateKey

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.

Request object method variants only take one parameter, a request object, which must be constructed before the call.

  • updateKeyAsync(UpdateKeyRequest request)

Methods that return long-running operations have "Async" method variants that return OperationFuture, which is used to track polling of the service.

  • updateKeyAsync(Key key, FieldMask updateMask)

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

  • updateKeyOperationCallable()

  • updateKeyCallable()

DeleteKey

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.

Request object method variants only take one parameter, a request object, which must be constructed before the call.

  • deleteKeyAsync(DeleteKeyRequest request)

Methods that return long-running operations have "Async" method variants that return OperationFuture, which is used to track polling of the service.

  • deleteKeyAsync(KeyName name)

  • deleteKeyAsync(String name)

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

  • deleteKeyOperationCallable()

  • deleteKeyCallable()

UndeleteKey

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.

Request object method variants only take one parameter, a request object, which must be constructed before the call.

  • undeleteKeyAsync(UndeleteKeyRequest request)

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

  • undeleteKeyOperationCallable()

  • undeleteKeyCallable()

LookupKey

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.

Request object method variants only take one parameter, a request object, which must be constructed before the call.

  • lookupKey(LookupKeyRequest request)

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

  • lookupKeyCallable()

See the individual methods for example code.

Many parameters require resource names to be formatted in a particular way. To assist with these names, this class includes a format method for each type of name, and additionally a parse method to extract the individual identifiers contained within names that are returned.

This class can be customized by passing in a custom instance of ApiKeysSettings to create(). For example:

To customize credentials:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 ApiKeysSettings apiKeysSettings =
     ApiKeysSettings.newBuilder()
         .setCredentialsProvider(FixedCredentialsProvider.create(myCredentials))
         .build();
 ApiKeysClient apiKeysClient = ApiKeysClient.create(apiKeysSettings);

To customize the endpoint:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 ApiKeysSettings apiKeysSettings = ApiKeysSettings.newBuilder().setEndpoint(myEndpoint).build();
 ApiKeysClient apiKeysClient = ApiKeysClient.create(apiKeysSettings);

To use REST (HTTP1.1/JSON) transport (instead of gRPC) for sending and receiving requests over the wire:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 ApiKeysSettings apiKeysSettings = ApiKeysSettings.newHttpJsonBuilder().build();
 ApiKeysClient apiKeysClient = ApiKeysClient.create(apiKeysSettings);

Please refer to the GitHub repository's samples for more quickstart code snippets.

Inheritance

java.lang.Object > ApiKeysClient

Static Methods

create()

public static final ApiKeysClient create()

Constructs an instance of ApiKeysClient with default settings.

Returns
Type Description
ApiKeysClient
Exceptions
Type Description
IOException

create(ApiKeysSettings settings)

public static final ApiKeysClient create(ApiKeysSettings settings)

Constructs an instance of ApiKeysClient, using the given settings. The channels are created based on the settings passed in, or defaults for any settings that are not set.

Parameter
Name Description
settings ApiKeysSettings
Returns
Type Description
ApiKeysClient
Exceptions
Type Description
IOException

create(ApiKeysStub stub)

public static final ApiKeysClient create(ApiKeysStub stub)

Constructs an instance of ApiKeysClient, using the given stub for making calls. This is for advanced usage - prefer using create(ApiKeysSettings).

Parameter
Name Description
stub ApiKeysStub
Returns
Type Description
ApiKeysClient

Constructors

ApiKeysClient(ApiKeysSettings settings)

protected ApiKeysClient(ApiKeysSettings settings)

Constructs an instance of ApiKeysClient, using the given settings. This is protected so that it is easy to make a subclass, but otherwise, the static factory methods should be preferred.

Parameter
Name Description
settings ApiKeysSettings

ApiKeysClient(ApiKeysStub stub)

protected ApiKeysClient(ApiKeysStub stub)
Parameter
Name Description
stub ApiKeysStub

Methods

awaitTermination(long duration, TimeUnit unit)

public boolean awaitTermination(long duration, TimeUnit unit)
Parameters
Name Description
duration long
unit TimeUnit
Returns
Type Description
boolean
Exceptions
Type Description
InterruptedException

close()

public final void close()

createKeyAsync(CreateKeyRequest request)

public final OperationFuture<Key,Empty> createKeyAsync(CreateKeyRequest request)

Creates a new API key.

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

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (ApiKeysClient apiKeysClient = ApiKeysClient.create()) {
   CreateKeyRequest request =
       CreateKeyRequest.newBuilder()
           .setParent(LocationName.of("[PROJECT]", "[LOCATION]").toString())
           .setKey(Key.newBuilder().build())
           .setKeyId("keyId101944282")
           .build();
   Key response = apiKeysClient.createKeyAsync(request).get();
 }
Parameter
Name Description
request CreateKeyRequest

The request object containing all of the parameters for the API call.
Returns
Type Description
OperationFuture<Key,Empty>

createKeyAsync(LocationName parent, Key key, String keyId)

public final OperationFuture<Key,Empty> createKeyAsync(LocationName parent, Key key, String keyId)

Creates a new API key.

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

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (ApiKeysClient apiKeysClient = ApiKeysClient.create()) {
   LocationName parent = LocationName.of("[PROJECT]", "[LOCATION]");
   Key key = Key.newBuilder().build();
   String keyId = "keyId101944282";
   Key response = apiKeysClient.createKeyAsync(parent, key, keyId).get();
 }
Parameters
Name Description
parent LocationName

Required. The project in which the API key is created.
key Key

Required. The API key fields to set at creation time. You can configure only the display_name, restrictions, and annotations fields.
keyId String

User specified key id (optional). If specified, it will become the final component of the key resource name.

The id must be unique within the project, must conform with RFC-1034, is restricted to lower-cased letters, and has a maximum length of 63 characters. In another word, the id must match the regular expression: a-z?.

The id must NOT be a UUID-like string.
Returns
Type Description
OperationFuture<Key,Empty>

createKeyAsync(String parent, Key key, String keyId)

public final OperationFuture<Key,Empty> createKeyAsync(String parent, Key key, String keyId)

Creates a new API key.

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

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (ApiKeysClient apiKeysClient = ApiKeysClient.create()) {
   String parent = LocationName.of("[PROJECT]", "[LOCATION]").toString();
   Key key = Key.newBuilder().build();
   String keyId = "keyId101944282";
   Key response = apiKeysClient.createKeyAsync(parent, key, keyId).get();
 }
Parameters
Name Description
parent String

Required. The project in which the API key is created.
key Key

Required. The API key fields to set at creation time. You can configure only the display_name, restrictions, and annotations fields.
keyId String

User specified key id (optional). If specified, it will become the final component of the key resource name.

The id must be unique within the project, must conform with RFC-1034, is restricted to lower-cased letters, and has a maximum length of 63 characters. In another word, the id must match the regular expression: a-z?.

The id must NOT be a UUID-like string.
Returns
Type Description
OperationFuture<Key,Empty>

createKeyCallable()

public final UnaryCallable<CreateKeyRequest,Operation> createKeyCallable()

Creates a new API key.

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

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (ApiKeysClient apiKeysClient = ApiKeysClient.create()) {
   CreateKeyRequest request =
       CreateKeyRequest.newBuilder()
           .setParent(LocationName.of("[PROJECT]", "[LOCATION]").toString())
           .setKey(Key.newBuilder().build())
           .setKeyId("keyId101944282")
           .build();
   ApiFuture<Operation> future = apiKeysClient.createKeyCallable().futureCall(request);
   // Do something.
   Operation response = future.get();
 }
Returns
Type Description
UnaryCallable<CreateKeyRequest,Operation>

createKeyOperationCallable()

public final OperationCallable<CreateKeyRequest,Key,Empty> createKeyOperationCallable()

Creates a new API key.

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

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (ApiKeysClient apiKeysClient = ApiKeysClient.create()) {
   CreateKeyRequest request =
       CreateKeyRequest.newBuilder()
           .setParent(LocationName.of("[PROJECT]", "[LOCATION]").toString())
           .setKey(Key.newBuilder().build())
           .setKeyId("keyId101944282")
           .build();
   OperationFuture<Key, Empty> future =
       apiKeysClient.createKeyOperationCallable().futureCall(request);
   // Do something.
   Key response = future.get();
 }
Returns
Type Description
OperationCallable<CreateKeyRequest,Key,Empty>

deleteKeyAsync(DeleteKeyRequest request)

public final OperationFuture<Key,Empty> deleteKeyAsync(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.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (ApiKeysClient apiKeysClient = ApiKeysClient.create()) {
   DeleteKeyRequest request =
       DeleteKeyRequest.newBuilder()
           .setName(KeyName.of("[PROJECT]", "[LOCATION]", "[KEY]").toString())
           .setEtag("etag3123477")
           .build();
   Key response = apiKeysClient.deleteKeyAsync(request).get();
 }
Parameter
Name Description
request DeleteKeyRequest

The request object containing all of the parameters for the API call.
Returns
Type Description
OperationFuture<Key,Empty>

deleteKeyAsync(KeyName name)

public final OperationFuture<Key,Empty> deleteKeyAsync(KeyName name)

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.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (ApiKeysClient apiKeysClient = ApiKeysClient.create()) {
   KeyName name = KeyName.of("[PROJECT]", "[LOCATION]", "[KEY]");
   Key response = apiKeysClient.deleteKeyAsync(name).get();
 }
Parameter
Name Description
name KeyName

Required. The resource name of the API key to be deleted.
Returns
Type Description
OperationFuture<Key,Empty>

deleteKeyAsync(String name)

public final OperationFuture<Key,Empty> deleteKeyAsync(String name)

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.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (ApiKeysClient apiKeysClient = ApiKeysClient.create()) {
   String name = KeyName.of("[PROJECT]", "[LOCATION]", "[KEY]").toString();
   Key response = apiKeysClient.deleteKeyAsync(name).get();
 }
Parameter
Name Description
name String

Required. The resource name of the API key to be deleted.
Returns
Type Description
OperationFuture<Key,Empty>

deleteKeyCallable()

public final UnaryCallable<DeleteKeyRequest,Operation> deleteKeyCallable()

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.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (ApiKeysClient apiKeysClient = ApiKeysClient.create()) {
   DeleteKeyRequest request =
       DeleteKeyRequest.newBuilder()
           .setName(KeyName.of("[PROJECT]", "[LOCATION]", "[KEY]").toString())
           .setEtag("etag3123477")
           .build();
   ApiFuture<Operation> future = apiKeysClient.deleteKeyCallable().futureCall(request);
   // Do something.
   Operation response = future.get();
 }
Returns
Type Description
UnaryCallable<DeleteKeyRequest,Operation>

deleteKeyOperationCallable()

public final OperationCallable<DeleteKeyRequest,Key,Empty> deleteKeyOperationCallable()

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.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (ApiKeysClient apiKeysClient = ApiKeysClient.create()) {
   DeleteKeyRequest request =
       DeleteKeyRequest.newBuilder()
           .setName(KeyName.of("[PROJECT]", "[LOCATION]", "[KEY]").toString())
           .setEtag("etag3123477")
           .build();
   OperationFuture<Key, Empty> future =
       apiKeysClient.deleteKeyOperationCallable().futureCall(request);
   // Do something.
   Key response = future.get();
 }
Returns
Type Description
OperationCallable<DeleteKeyRequest,Key,Empty>

getHttpJsonOperationsClient()

public final OperationsClient getHttpJsonOperationsClient()

Returns the OperationsClient that can be used to query the status of a long-running operation returned by another API method call.

Returns
Type Description
OperationsClient

getKey(GetKeyRequest request)

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

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (ApiKeysClient apiKeysClient = ApiKeysClient.create()) {
   GetKeyRequest request =
       GetKeyRequest.newBuilder()
           .setName(KeyName.of("[PROJECT]", "[LOCATION]", "[KEY]").toString())
           .build();
   Key response = apiKeysClient.getKey(request);
 }
Parameter
Name Description
request GetKeyRequest

The request object containing all of the parameters for the API call.
Returns
Type Description
Key

getKey(KeyName name)

public final Key getKey(KeyName name)

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.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (ApiKeysClient apiKeysClient = ApiKeysClient.create()) {
   KeyName name = KeyName.of("[PROJECT]", "[LOCATION]", "[KEY]");
   Key response = apiKeysClient.getKey(name);
 }
Parameter
Name Description
name KeyName

Required. The resource name of the API key to get.
Returns
Type Description
Key

getKey(String name)

public final Key getKey(String name)

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.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (ApiKeysClient apiKeysClient = ApiKeysClient.create()) {
   String name = KeyName.of("[PROJECT]", "[LOCATION]", "[KEY]").toString();
   Key response = apiKeysClient.getKey(name);
 }
Parameter
Name Description
name String

Required. The resource name of the API key to get.
Returns
Type Description
Key

getKeyCallable()

public final UnaryCallable<GetKeyRequest,Key> getKeyCallable()

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.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (ApiKeysClient apiKeysClient = ApiKeysClient.create()) {
   GetKeyRequest request =
       GetKeyRequest.newBuilder()
           .setName(KeyName.of("[PROJECT]", "[LOCATION]", "[KEY]").toString())
           .build();
   ApiFuture<Key> future = apiKeysClient.getKeyCallable().futureCall(request);
   // Do something.
   Key response = future.get();
 }
Returns
Type Description
UnaryCallable<GetKeyRequest,Key>

getKeyString(GetKeyStringRequest request)

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

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (ApiKeysClient apiKeysClient = ApiKeysClient.create()) {
   GetKeyStringRequest request =
       GetKeyStringRequest.newBuilder()
           .setName(KeyName.of("[PROJECT]", "[LOCATION]", "[KEY]").toString())
           .build();
   GetKeyStringResponse response = apiKeysClient.getKeyString(request);
 }
Parameter
Name Description
request GetKeyStringRequest

The request object containing all of the parameters for the API call.
Returns
Type Description
GetKeyStringResponse

getKeyString(KeyName name)

public final GetKeyStringResponse getKeyString(KeyName name)

Get the key string for an API key.

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

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (ApiKeysClient apiKeysClient = ApiKeysClient.create()) {
   KeyName name = KeyName.of("[PROJECT]", "[LOCATION]", "[KEY]");
   GetKeyStringResponse response = apiKeysClient.getKeyString(name);
 }
Parameter
Name Description
name KeyName

Required. The resource name of the API key to be retrieved.
Returns
Type Description
GetKeyStringResponse

getKeyString(String name)

public final GetKeyStringResponse getKeyString(String name)

Get the key string for an API key.

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

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (ApiKeysClient apiKeysClient = ApiKeysClient.create()) {
   String name = KeyName.of("[PROJECT]", "[LOCATION]", "[KEY]").toString();
   GetKeyStringResponse response = apiKeysClient.getKeyString(name);
 }
Parameter
Name Description
name String

Required. The resource name of the API key to be retrieved.
Returns
Type Description
GetKeyStringResponse

getKeyStringCallable()

public final UnaryCallable<GetKeyStringRequest,GetKeyStringResponse> getKeyStringCallable()

Get the key string for an API key.

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

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (ApiKeysClient apiKeysClient = ApiKeysClient.create()) {
   GetKeyStringRequest request =
       GetKeyStringRequest.newBuilder()
           .setName(KeyName.of("[PROJECT]", "[LOCATION]", "[KEY]").toString())
           .build();
   ApiFuture<GetKeyStringResponse> future =
       apiKeysClient.getKeyStringCallable().futureCall(request);
   // Do something.
   GetKeyStringResponse response = future.get();
 }
Returns
Type Description
UnaryCallable<GetKeyStringRequest,GetKeyStringResponse>

getOperationsClient()

public final OperationsClient getOperationsClient()

Returns the OperationsClient that can be used to query the status of a long-running operation returned by another API method call.

Returns
Type Description
OperationsClient

getSettings()

public final ApiKeysSettings getSettings()
Returns
Type Description
ApiKeysSettings

getStub()

public ApiKeysStub getStub()
Returns
Type Description
ApiKeysStub

isShutdown()

public boolean isShutdown()
Returns
Type Description
boolean

isTerminated()

public boolean isTerminated()
Returns
Type Description
boolean

listKeys(ListKeysRequest request)

public final ApiKeysClient.ListKeysPagedResponse 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.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (ApiKeysClient apiKeysClient = ApiKeysClient.create()) {
   ListKeysRequest request =
       ListKeysRequest.newBuilder()
           .setParent(LocationName.of("[PROJECT]", "[LOCATION]").toString())
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .setShowDeleted(true)
           .build();
   for (Key element : apiKeysClient.listKeys(request).iterateAll()) {
     // doThingsWith(element);
   }
 }
Parameter
Name Description
request ListKeysRequest

The request object containing all of the parameters for the API call.
Returns
Type Description
ApiKeysClient.ListKeysPagedResponse

listKeys(LocationName parent)

public final ApiKeysClient.ListKeysPagedResponse listKeys(LocationName parent)

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.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (ApiKeysClient apiKeysClient = ApiKeysClient.create()) {
   LocationName parent = LocationName.of("[PROJECT]", "[LOCATION]");
   for (Key element : apiKeysClient.listKeys(parent).iterateAll()) {
     // doThingsWith(element);
   }
 }
Parameter
Name Description
parent LocationName

Required. Lists all API keys associated with this project.
Returns
Type Description
ApiKeysClient.ListKeysPagedResponse

listKeys(String parent)

public final ApiKeysClient.ListKeysPagedResponse listKeys(String parent)

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.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (ApiKeysClient apiKeysClient = ApiKeysClient.create()) {
   String parent = LocationName.of("[PROJECT]", "[LOCATION]").toString();
   for (Key element : apiKeysClient.listKeys(parent).iterateAll()) {
     // doThingsWith(element);
   }
 }
Parameter
Name Description
parent String

Required. Lists all API keys associated with this project.
Returns
Type Description
ApiKeysClient.ListKeysPagedResponse

listKeysCallable()

public final UnaryCallable<ListKeysRequest,ListKeysResponse> listKeysCallable()

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.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (ApiKeysClient apiKeysClient = ApiKeysClient.create()) {
   ListKeysRequest request =
       ListKeysRequest.newBuilder()
           .setParent(LocationName.of("[PROJECT]", "[LOCATION]").toString())
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .setShowDeleted(true)
           .build();
   while (true) {
     ListKeysResponse response = apiKeysClient.listKeysCallable().call(request);
     for (Key element : response.getKeysList()) {
       // doThingsWith(element);
     }
     String nextPageToken = response.getNextPageToken();
     if (!Strings.isNullOrEmpty(nextPageToken)) {
       request = request.toBuilder().setPageToken(nextPageToken).build();
     } else {
       break;
     }
   }
 }
Returns
Type Description
UnaryCallable<ListKeysRequest,ListKeysResponse>

listKeysPagedCallable()

public final UnaryCallable<ListKeysRequest,ApiKeysClient.ListKeysPagedResponse> listKeysPagedCallable()

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.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (ApiKeysClient apiKeysClient = ApiKeysClient.create()) {
   ListKeysRequest request =
       ListKeysRequest.newBuilder()
           .setParent(LocationName.of("[PROJECT]", "[LOCATION]").toString())
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .setShowDeleted(true)
           .build();
   ApiFuture<Key> future = apiKeysClient.listKeysPagedCallable().futureCall(request);
   // Do something.
   for (Key element : future.get().iterateAll()) {
     // doThingsWith(element);
   }
 }
Returns
Type Description
UnaryCallable<ListKeysRequest,ListKeysPagedResponse>

lookupKey(LookupKeyRequest request)

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

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (ApiKeysClient apiKeysClient = ApiKeysClient.create()) {
   LookupKeyRequest request =
       LookupKeyRequest.newBuilder().setKeyString("keyString-1988270256").build();
   LookupKeyResponse response = apiKeysClient.lookupKey(request);
 }
Parameter
Name Description
request LookupKeyRequest

The request object containing all of the parameters for the API call.
Returns
Type Description
LookupKeyResponse

lookupKeyCallable()

public final UnaryCallable<LookupKeyRequest,LookupKeyResponse> lookupKeyCallable()

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.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (ApiKeysClient apiKeysClient = ApiKeysClient.create()) {
   LookupKeyRequest request =
       LookupKeyRequest.newBuilder().setKeyString("keyString-1988270256").build();
   ApiFuture<LookupKeyResponse> future = apiKeysClient.lookupKeyCallable().futureCall(request);
   // Do something.
   LookupKeyResponse response = future.get();
 }
Returns
Type Description
UnaryCallable<LookupKeyRequest,LookupKeyResponse>

shutdown()

public void shutdown()

shutdownNow()

public void shutdownNow()

undeleteKeyAsync(UndeleteKeyRequest request)

public final OperationFuture<Key,Empty> undeleteKeyAsync(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.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (ApiKeysClient apiKeysClient = ApiKeysClient.create()) {
   UndeleteKeyRequest request =
       UndeleteKeyRequest.newBuilder()
           .setName(KeyName.of("[PROJECT]", "[LOCATION]", "[KEY]").toString())
           .build();
   Key response = apiKeysClient.undeleteKeyAsync(request).get();
 }
Parameter
Name Description
request UndeleteKeyRequest

The request object containing all of the parameters for the API call.
Returns
Type Description
OperationFuture<Key,Empty>

undeleteKeyCallable()

public final UnaryCallable<UndeleteKeyRequest,Operation> undeleteKeyCallable()

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.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (ApiKeysClient apiKeysClient = ApiKeysClient.create()) {
   UndeleteKeyRequest request =
       UndeleteKeyRequest.newBuilder()
           .setName(KeyName.of("[PROJECT]", "[LOCATION]", "[KEY]").toString())
           .build();
   ApiFuture<Operation> future = apiKeysClient.undeleteKeyCallable().futureCall(request);
   // Do something.
   Operation response = future.get();
 }
Returns
Type Description
UnaryCallable<UndeleteKeyRequest,Operation>

undeleteKeyOperationCallable()

public final OperationCallable<UndeleteKeyRequest,Key,Empty> undeleteKeyOperationCallable()

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.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (ApiKeysClient apiKeysClient = ApiKeysClient.create()) {
   UndeleteKeyRequest request =
       UndeleteKeyRequest.newBuilder()
           .setName(KeyName.of("[PROJECT]", "[LOCATION]", "[KEY]").toString())
           .build();
   OperationFuture<Key, Empty> future =
       apiKeysClient.undeleteKeyOperationCallable().futureCall(request);
   // Do something.
   Key response = future.get();
 }
Returns
Type Description
OperationCallable<UndeleteKeyRequest,Key,Empty>

updateKeyAsync(Key key, FieldMask updateMask)

public final OperationFuture<Key,Empty> updateKeyAsync(Key key, FieldMask updateMask)

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.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (ApiKeysClient apiKeysClient = ApiKeysClient.create()) {
   Key key = Key.newBuilder().build();
   FieldMask updateMask = FieldMask.newBuilder().build();
   Key response = apiKeysClient.updateKeyAsync(key, updateMask).get();
 }
Parameters
Name Description
key Key

Required. Set the name field to the resource name of the API key to be updated. You can update only the display_name, restrictions, and annotations fields.
updateMask FieldMask

The field mask specifies which fields to be updated as part of this request. All other fields are ignored. Mutable fields are: display_name, restrictions, and annotations. If an update mask is not provided, the service treats it as an implied mask equivalent to all allowed fields that are set on the wire. If the field mask has a special value "*", the service treats it equivalent to replace all allowed mutable fields.
Returns
Type Description
OperationFuture<Key,Empty>

updateKeyAsync(UpdateKeyRequest request)

public final OperationFuture<Key,Empty> updateKeyAsync(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.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (ApiKeysClient apiKeysClient = ApiKeysClient.create()) {
   UpdateKeyRequest request =
       UpdateKeyRequest.newBuilder()
           .setKey(Key.newBuilder().build())
           .setUpdateMask(FieldMask.newBuilder().build())
           .build();
   Key response = apiKeysClient.updateKeyAsync(request).get();
 }
Parameter
Name Description
request UpdateKeyRequest

The request object containing all of the parameters for the API call.
Returns
Type Description
OperationFuture<Key,Empty>

updateKeyCallable()

public final UnaryCallable<UpdateKeyRequest,Operation> updateKeyCallable()

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.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (ApiKeysClient apiKeysClient = ApiKeysClient.create()) {
   UpdateKeyRequest request =
       UpdateKeyRequest.newBuilder()
           .setKey(Key.newBuilder().build())
           .setUpdateMask(FieldMask.newBuilder().build())
           .build();
   ApiFuture<Operation> future = apiKeysClient.updateKeyCallable().futureCall(request);
   // Do something.
   Operation response = future.get();
 }
Returns
Type Description
UnaryCallable<UpdateKeyRequest,Operation>

updateKeyOperationCallable()

public final OperationCallable<UpdateKeyRequest,Key,Empty> updateKeyOperationCallable()

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.

Sample code:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (ApiKeysClient apiKeysClient = ApiKeysClient.create()) {
   UpdateKeyRequest request =
       UpdateKeyRequest.newBuilder()
           .setKey(Key.newBuilder().build())
           .setUpdateMask(FieldMask.newBuilder().build())
           .build();
   OperationFuture<Key, Empty> future =
       apiKeysClient.updateKeyOperationCallable().futureCall(request);
   // Do something.
   Key response = future.get();
 }
Returns
Type Description
OperationCallable<UpdateKeyRequest,Key,Empty>