- 0.49.0 (latest)
- 0.47.0
- 0.46.0
- 0.45.0
- 0.44.0
- 0.43.0
- 0.42.0
- 0.41.0
- 0.40.0
- 0.39.0
- 0.38.0
- 0.37.0
- 0.35.0
- 0.34.0
- 0.33.0
- 0.32.0
- 0.31.0
- 0.30.0
- 0.29.0
- 0.28.0
- 0.27.0
- 0.26.0
- 0.25.0
- 0.22.0
- 0.21.0
- 0.20.0
- 0.19.0
- 0.18.0
- 0.17.0
- 0.16.0
- 0.15.0
- 0.14.0
- 0.13.0
- 0.12.0
- 0.11.0
- 0.10.0
- 0.9.0
- 0.8.0
- 0.7.0
- 0.6.0
- 0.5.0
- 0.4.0
- 0.3.0
- 0.2.0
- 0.1.2
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 total timeout of getKey to 30 seconds:
// 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()
.setTotalTimeout(Duration.ofSeconds(30))
.build());
ApiKeysSettings apiKeysSettings = apiKeysSettingsBuilder.build();
Static Methods
create(ApiKeysStubSettings stub)
public static final ApiKeysSettings create(ApiKeysStubSettings stub)| Name | Description |
| stub | ApiKeysStubSettings |
| Type | Description |
| ApiKeysSettings |
| Type | Description |
| IOException |
defaultApiClientHeaderProviderBuilder()
public static ApiClientHeaderProvider.Builder defaultApiClientHeaderProviderBuilder()| Type | Description |
| Builder |
defaultCredentialsProviderBuilder()
public static GoogleCredentialsProvider.Builder defaultCredentialsProviderBuilder()Returns a builder for the default credentials for this service.
| Type | Description |
| Builder |
defaultExecutorProviderBuilder()
public static InstantiatingExecutorProvider.Builder defaultExecutorProviderBuilder()Returns a builder for the default ExecutorProvider for this service.
| Type | Description |
| Builder |
defaultGrpcTransportProviderBuilder()
public static InstantiatingGrpcChannelProvider.Builder defaultGrpcTransportProviderBuilder()Returns a builder for the default gRPC ChannelProvider for this service.
| Type | Description |
| Builder |
defaultHttpJsonTransportProviderBuilder()
public static InstantiatingHttpJsonChannelProvider.Builder defaultHttpJsonTransportProviderBuilder()Returns a builder for the default REST ChannelProvider for this service.
| Type | Description |
| Builder |
defaultTransportChannelProvider()
public static TransportChannelProvider defaultTransportChannelProvider()| Type | Description |
| TransportChannelProvider |
getDefaultEndpoint()
public static String getDefaultEndpoint()Returns the default service endpoint.
| Type | Description |
| String |
getDefaultServiceScopes()
public static List<String> getDefaultServiceScopes()Returns the default service scopes.
| Type | Description |
| List<String> |
newBuilder()
public static ApiKeysSettings.Builder newBuilder()Returns a new gRPC builder for this class.
| Type | Description |
| ApiKeysSettings.Builder |
newBuilder(ClientContext clientContext)
public static ApiKeysSettings.Builder newBuilder(ClientContext clientContext)Returns a new builder for this class.
| Name | Description |
| clientContext | ClientContext |
| Type | Description |
| ApiKeysSettings.Builder |
newHttpJsonBuilder()
public static ApiKeysSettings.Builder newHttpJsonBuilder()Returns a new REST builder for this class.
| Type | Description |
| ApiKeysSettings.Builder |
Constructors
ApiKeysSettings(ApiKeysSettings.Builder settingsBuilder)
protected ApiKeysSettings(ApiKeysSettings.Builder settingsBuilder)| Name | Description |
| settingsBuilder | ApiKeysSettings.Builder |
Methods
createKeyOperationSettings()
public OperationCallSettings<CreateKeyRequest,Key,Empty> createKeyOperationSettings()Returns the object with the settings used for calls to createKey.
| Type | Description |
| OperationCallSettings<CreateKeyRequest,Key,Empty> |
createKeySettings()
public UnaryCallSettings<CreateKeyRequest,Operation> createKeySettings()Returns the object with the settings used for calls to createKey.
| Type | Description |
| UnaryCallSettings<CreateKeyRequest,Operation> |
deleteKeyOperationSettings()
public OperationCallSettings<DeleteKeyRequest,Key,Empty> deleteKeyOperationSettings()Returns the object with the settings used for calls to deleteKey.
| Type | Description |
| OperationCallSettings<DeleteKeyRequest,Key,Empty> |
deleteKeySettings()
public UnaryCallSettings<DeleteKeyRequest,Operation> deleteKeySettings()Returns the object with the settings used for calls to deleteKey.
| Type | Description |
| UnaryCallSettings<DeleteKeyRequest,Operation> |
getKeySettings()
public UnaryCallSettings<GetKeyRequest,Key> getKeySettings()Returns the object with the settings used for calls to getKey.
| Type | Description |
| UnaryCallSettings<GetKeyRequest,Key> |
getKeyStringSettings()
public UnaryCallSettings<GetKeyStringRequest,GetKeyStringResponse> getKeyStringSettings()Returns the object with the settings used for calls to getKeyString.
| Type | Description |
| UnaryCallSettings<GetKeyStringRequest,GetKeyStringResponse> |
listKeysSettings()
public PagedCallSettings<ListKeysRequest,ListKeysResponse,ApiKeysClient.ListKeysPagedResponse> listKeysSettings()Returns the object with the settings used for calls to listKeys.
| Type | Description |
| PagedCallSettings<ListKeysRequest,ListKeysResponse,ListKeysPagedResponse> |
lookupKeySettings()
public UnaryCallSettings<LookupKeyRequest,LookupKeyResponse> lookupKeySettings()Returns the object with the settings used for calls to lookupKey.
| Type | Description |
| UnaryCallSettings<LookupKeyRequest,LookupKeyResponse> |
toBuilder()
public ApiKeysSettings.Builder toBuilder()Returns a builder containing all the values of this settings class.
| Type | Description |
| ApiKeysSettings.Builder |
undeleteKeyOperationSettings()
public OperationCallSettings<UndeleteKeyRequest,Key,Empty> undeleteKeyOperationSettings()Returns the object with the settings used for calls to undeleteKey.
| Type | Description |
| OperationCallSettings<UndeleteKeyRequest,Key,Empty> |
undeleteKeySettings()
public UnaryCallSettings<UndeleteKeyRequest,Operation> undeleteKeySettings()Returns the object with the settings used for calls to undeleteKey.
| Type | Description |
| UnaryCallSettings<UndeleteKeyRequest,Operation> |
updateKeyOperationSettings()
public OperationCallSettings<UpdateKeyRequest,Key,Empty> updateKeyOperationSettings()Returns the object with the settings used for calls to updateKey.
| Type | Description |
| OperationCallSettings<UpdateKeyRequest,Key,Empty> |
updateKeySettings()
public UnaryCallSettings<UpdateKeyRequest,Operation> updateKeySettings()Returns the object with the settings used for calls to updateKey.
| Type | Description |
| UnaryCallSettings<UpdateKeyRequest,Operation> |