Class ApiKeysSettings (0.51.0) 

public class ApiKeysSettings extends ClientSettings<ApiKeysSettings>

Settings class to configure an instance of ApiKeysClient.

The default instance has everything set to sensible defaults:

  • The default service address (apikeys.googleapis.com) and default port (443) are used.
  • Credentials are acquired automatically through Application Default Credentials.
  • Retries are configured for idempotent methods but not for non-idempotent methods.

The builder of this class is recursive, so contained classes are themselves builders. When build() is called, the tree of builders is called to create the complete settings object.

For example, to set the RetrySettings of getKey:


 // 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.Builder apiKeysSettingsBuilder = ApiKeysSettings.newBuilder();
 apiKeysSettingsBuilder
     .getKeySettings()
     .setRetrySettings(
         apiKeysSettingsBuilder
             .getKeySettings()
             .getRetrySettings()
             .toBuilder()
             .setInitialRetryDelayDuration(Duration.ofSeconds(1))
             .setInitialRpcTimeoutDuration(Duration.ofSeconds(5))
             .setMaxAttempts(5)
             .setMaxRetryDelayDuration(Duration.ofSeconds(30))
             .setMaxRpcTimeoutDuration(Duration.ofSeconds(60))
             .setRetryDelayMultiplier(1.3)
             .setRpcTimeoutMultiplier(1.5)
             .setTotalTimeoutDuration(Duration.ofSeconds(300))
             .build());
 ApiKeysSettings apiKeysSettings = apiKeysSettingsBuilder.build();

Please refer to the Client Side Retry Guide for additional support in setting retries.

To configure the RetrySettings of a Long Running Operation method, create an OperationTimedPollAlgorithm object and update the RPC's polling algorithm. For example, to configure the RetrySettings for createKey:


 // 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.Builder apiKeysSettingsBuilder = ApiKeysSettings.newBuilder();
 TimedRetryAlgorithm timedRetryAlgorithm =
     OperationalTimedPollAlgorithm.create(
         RetrySettings.newBuilder()
             .setInitialRetryDelayDuration(Duration.ofMillis(500))
             .setRetryDelayMultiplier(1.5)
             .setMaxRetryDelay(Duration.ofMillis(5000))
             .setTotalTimeoutDuration(Duration.ofHours(24))
             .build());
 apiKeysSettingsBuilder
     .createClusterOperationSettings()
     .setPollingAlgorithm(timedRetryAlgorithm)
     .build();

Inheritance

java.lang.Object > ClientSettings > ApiKeysSettings

Static Methods

create(ApiKeysStubSettings stub)

public static final ApiKeysSettings create(ApiKeysStubSettings stub)
Parameter
Name Description
stub ApiKeysStubSettings
Returns
Type Description
ApiKeysSettings
Exceptions
Type Description
IOException

defaultApiClientHeaderProviderBuilder()

public static ApiClientHeaderProvider.Builder defaultApiClientHeaderProviderBuilder()
Returns
Type Description
Builder

defaultCredentialsProviderBuilder()

public static GoogleCredentialsProvider.Builder defaultCredentialsProviderBuilder()

Returns a builder for the default credentials for this service.

Returns
Type Description
Builder

defaultExecutorProviderBuilder()

public static InstantiatingExecutorProvider.Builder defaultExecutorProviderBuilder()

Returns a builder for the default ExecutorProvider for this service.

Returns
Type Description
Builder

defaultGrpcTransportProviderBuilder()

public static InstantiatingGrpcChannelProvider.Builder defaultGrpcTransportProviderBuilder()

Returns a builder for the default gRPC ChannelProvider for this service.

Returns
Type Description
Builder

defaultHttpJsonTransportProviderBuilder()

public static InstantiatingHttpJsonChannelProvider.Builder defaultHttpJsonTransportProviderBuilder()

Returns a builder for the default REST ChannelProvider for this service.

Returns
Type Description
Builder

defaultTransportChannelProvider()

public static TransportChannelProvider defaultTransportChannelProvider()
Returns
Type Description
TransportChannelProvider

getDefaultEndpoint()

public static String getDefaultEndpoint()

Returns the default service endpoint.

Returns
Type Description
String

getDefaultServiceScopes()

public static List<String> getDefaultServiceScopes()

Returns the default service scopes.

Returns
Type Description
List<String>

newBuilder()

public static ApiKeysSettings.Builder newBuilder()

Returns a new gRPC builder for this class.

Returns
Type Description
ApiKeysSettings.Builder

newBuilder(ClientContext clientContext)

public static ApiKeysSettings.Builder newBuilder(ClientContext clientContext)

Returns a new builder for this class.

Parameter
Name Description
clientContext ClientContext
Returns
Type Description
ApiKeysSettings.Builder

newHttpJsonBuilder()

public static ApiKeysSettings.Builder newHttpJsonBuilder()

Returns a new REST builder for this class.

Returns
Type Description
ApiKeysSettings.Builder

Constructors

ApiKeysSettings(ApiKeysSettings.Builder settingsBuilder)

protected ApiKeysSettings(ApiKeysSettings.Builder settingsBuilder)
Parameter
Name Description
settingsBuilder ApiKeysSettings.Builder

Methods

createKeyOperationSettings()

public OperationCallSettings<CreateKeyRequest,Key,Empty> createKeyOperationSettings()

Returns the object with the settings used for calls to createKey.

Returns
Type Description
OperationCallSettings<CreateKeyRequest,Key,Empty>

createKeySettings()

public UnaryCallSettings<CreateKeyRequest,Operation> createKeySettings()

Returns the object with the settings used for calls to createKey.

Returns
Type Description
UnaryCallSettings<CreateKeyRequest,Operation>

deleteKeyOperationSettings()

public OperationCallSettings<DeleteKeyRequest,Key,Empty> deleteKeyOperationSettings()

Returns the object with the settings used for calls to deleteKey.

Returns
Type Description
OperationCallSettings<DeleteKeyRequest,Key,Empty>

deleteKeySettings()

public UnaryCallSettings<DeleteKeyRequest,Operation> deleteKeySettings()

Returns the object with the settings used for calls to deleteKey.

Returns
Type Description
UnaryCallSettings<DeleteKeyRequest,Operation>

getKeySettings()

public UnaryCallSettings<GetKeyRequest,Key> getKeySettings()

Returns the object with the settings used for calls to getKey.

Returns
Type Description
UnaryCallSettings<GetKeyRequest,Key>

getKeyStringSettings()

public UnaryCallSettings<GetKeyStringRequest,GetKeyStringResponse> getKeyStringSettings()

Returns the object with the settings used for calls to getKeyString.

Returns
Type Description
UnaryCallSettings<GetKeyStringRequest,GetKeyStringResponse>

listKeysSettings()

public PagedCallSettings<ListKeysRequest,ListKeysResponse,ApiKeysClient.ListKeysPagedResponse> listKeysSettings()

Returns the object with the settings used for calls to listKeys.

Returns
Type Description
PagedCallSettings<ListKeysRequest,ListKeysResponse,ListKeysPagedResponse>

lookupKeySettings()

public UnaryCallSettings<LookupKeyRequest,LookupKeyResponse> lookupKeySettings()

Returns the object with the settings used for calls to lookupKey.

Returns
Type Description
UnaryCallSettings<LookupKeyRequest,LookupKeyResponse>

toBuilder()

public ApiKeysSettings.Builder toBuilder()

Returns a builder containing all the values of this settings class.

Returns
Type Description
ApiKeysSettings.Builder
Overrides

undeleteKeyOperationSettings()

public OperationCallSettings<UndeleteKeyRequest,Key,Empty> undeleteKeyOperationSettings()

Returns the object with the settings used for calls to undeleteKey.

Returns
Type Description
OperationCallSettings<UndeleteKeyRequest,Key,Empty>

undeleteKeySettings()

public UnaryCallSettings<UndeleteKeyRequest,Operation> undeleteKeySettings()

Returns the object with the settings used for calls to undeleteKey.

Returns
Type Description
UnaryCallSettings<UndeleteKeyRequest,Operation>

updateKeyOperationSettings()

public OperationCallSettings<UpdateKeyRequest,Key,Empty> updateKeyOperationSettings()

Returns the object with the settings used for calls to updateKey.

Returns
Type Description
OperationCallSettings<UpdateKeyRequest,Key,Empty>

updateKeySettings()

public UnaryCallSettings<UpdateKeyRequest,Operation> updateKeySettings()

Returns the object with the settings used for calls to updateKey.

Returns
Type Description
UnaryCallSettings<UpdateKeyRequest,Operation>