public class ApiKeysStubSettings extends StubSettings<ApiKeysStubSettings>
Settings class to configure an instance of ApiKeysStub.
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
ApiKeysStubSettings.Builder apiKeysSettingsBuilder = ApiKeysStubSettings.newBuilder();
apiKeysSettingsBuilder
.getKeySettings()
.setRetrySettings(
apiKeysSettingsBuilder.getKeySettings().getRetrySettings().toBuilder()
.setTotalTimeout(Duration.ofSeconds(30))
.build());
ApiKeysStubSettings apiKeysSettings = apiKeysSettingsBuilder.build();
Static Methods
public static ApiClientHeaderProvider.Builder defaultApiClientHeaderProviderBuilder()
Returns
defaultCredentialsProviderBuilder()
public static GoogleCredentialsProvider.Builder defaultCredentialsProviderBuilder()
Returns a builder for the default credentials for this service.
defaultExecutorProviderBuilder()
public static InstantiatingExecutorProvider.Builder defaultExecutorProviderBuilder()
Returns a builder for the default ExecutorProvider for this service.
public static ApiClientHeaderProvider.Builder defaultGrpcApiClientHeaderProviderBuilder()
Returns
defaultGrpcTransportProviderBuilder()
public static InstantiatingGrpcChannelProvider.Builder defaultGrpcTransportProviderBuilder()
Returns a builder for the default gRPC ChannelProvider for this service.
public static ApiClientHeaderProvider.Builder defaultHttpJsonApiClientHeaderProviderBuilder()
Returns
defaultHttpJsonTransportProviderBuilder()
public static InstantiatingHttpJsonChannelProvider.Builder defaultHttpJsonTransportProviderBuilder()
Returns a builder for the default REST ChannelProvider for this service.
defaultTransportChannelProvider()
public static TransportChannelProvider defaultTransportChannelProvider()
Returns
getDefaultEndpoint()
public static String getDefaultEndpoint()
Returns the default service endpoint.
getDefaultMtlsEndpoint()
public static String getDefaultMtlsEndpoint()
Returns the default mTLS service endpoint.
getDefaultServiceScopes()
public static List<String> getDefaultServiceScopes()
Returns the default service scopes.
newBuilder()
public static ApiKeysStubSettings.Builder newBuilder()
Returns a new gRPC builder for this class.
newBuilder(ClientContext clientContext)
public static ApiKeysStubSettings.Builder newBuilder(ClientContext clientContext)
Returns a new builder for this class.
newHttpJsonBuilder()
public static ApiKeysStubSettings.Builder newHttpJsonBuilder()
Returns a new REST builder for this class.
Constructors
ApiKeysStubSettings(ApiKeysStubSettings.Builder settingsBuilder)
protected ApiKeysStubSettings(ApiKeysStubSettings.Builder settingsBuilder)
Parameter
Methods
createKeyOperationSettings()
public OperationCallSettings<CreateKeyRequest,Key,Empty> createKeyOperationSettings()
Returns the object with the settings used for calls to createKey.
createKeySettings()
public UnaryCallSettings<CreateKeyRequest,Operation> createKeySettings()
Returns the object with the settings used for calls to createKey.
createStub()
public ApiKeysStub createStub()
Returns
Exceptions
deleteKeyOperationSettings()
public OperationCallSettings<DeleteKeyRequest,Key,Empty> deleteKeyOperationSettings()
Returns the object with the settings used for calls to deleteKey.
deleteKeySettings()
public UnaryCallSettings<DeleteKeyRequest,Operation> deleteKeySettings()
Returns the object with the settings used for calls to deleteKey.
getKeySettings()
public UnaryCallSettings<GetKeyRequest,Key> getKeySettings()
Returns the object with the settings used for calls to getKey.
getKeyStringSettings()
public UnaryCallSettings<GetKeyStringRequest,GetKeyStringResponse> getKeyStringSettings()
Returns the object with the settings used for calls to getKeyString.
listKeysSettings()
public PagedCallSettings<ListKeysRequest,ListKeysResponse,ApiKeysClient.ListKeysPagedResponse> listKeysSettings()
Returns the object with the settings used for calls to listKeys.
lookupKeySettings()
public UnaryCallSettings<LookupKeyRequest,LookupKeyResponse> lookupKeySettings()
Returns the object with the settings used for calls to lookupKey.
toBuilder()
public ApiKeysStubSettings.Builder toBuilder()
Returns a builder containing all the values of this settings class.
undeleteKeyOperationSettings()
public OperationCallSettings<UndeleteKeyRequest,Key,Empty> undeleteKeyOperationSettings()
Returns the object with the settings used for calls to undeleteKey.
undeleteKeySettings()
public UnaryCallSettings<UndeleteKeyRequest,Operation> undeleteKeySettings()
Returns the object with the settings used for calls to undeleteKey.
updateKeyOperationSettings()
public OperationCallSettings<UpdateKeyRequest,Key,Empty> updateKeyOperationSettings()
Returns the object with the settings used for calls to updateKey.
updateKeySettings()
public UnaryCallSettings<UpdateKeyRequest,Operation> updateKeySettings()
Returns the object with the settings used for calls to updateKey.
