Send feedback Class EkmServiceSettings (2.38.0) Stay organized with collections Save and categorize content based on your preferences.
Version 2.38.0keyboard_arrow_down
public class EkmServiceSettings extends ClientSettings<EkmServiceSettings> Settings class to configure an instance of EkmServiceClient .
The default instance has everything set to sensible defaults:
The default service address (cloudkms.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 getEkmConnection 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
EkmServiceSettings . Builder ekmServiceSettingsBuilder = EkmServiceSettings . newBuilder ();
ekmServiceSettingsBuilder
. getEkmConnectionSettings ()
. setRetrySettings (
ekmServiceSettingsBuilder
. getEkmConnectionSettings ()
. getRetrySettings ()
. toBuilder ()
. setTotalTimeout ( Duration . ofSeconds ( 30 ))
. build ());
EkmServiceSettings ekmServiceSettings = ekmServiceSettingsBuilder . build ();
Static Methods create(EkmServiceStubSettings stub)
public static final EkmServiceSettings create ( EkmServiceStubSettings stub )
public static ApiClientHeaderProvider . Builder defaultApiClientHeaderProviderBuilder () Beta
The surface for customizing headers is not stable yet and may change in the future.
This feature is covered by the Pre-GA Offerings Terms of the Terms of Service. Pre-GA libraries might have limited support, and changes to pre-GA libraries might not be compatible with other pre-GA versions. For more information, see the launch stage descriptions.
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.
defaultGrpcTransportProviderBuilder()
public static InstantiatingGrpcChannelProvider . Builder defaultGrpcTransportProviderBuilder () Returns a builder for the default gRPC ChannelProvider for this service.
defaultHttpJsonTransportProviderBuilder()
public static InstantiatingHttpJsonChannelProvider . Builder defaultHttpJsonTransportProviderBuilder () Beta
This feature is covered by the Pre-GA Offerings Terms of the Terms of Service. Pre-GA libraries might have limited support, and changes to pre-GA libraries might not be compatible with other pre-GA versions. For more information, see the launch stage descriptions.
Returns a builder for the default REST ChannelProvider for this service.
defaultTransportChannelProvider()
public static TransportChannelProvider defaultTransportChannelProvider () getDefaultEndpoint()
public static String getDefaultEndpoint () Returns the default service endpoint.
getDefaultServiceScopes()
public static List<String> getDefaultServiceScopes () Returns the default service scopes.
newBuilder()
public static EkmServiceSettings . Builder newBuilder () Returns a new gRPC builder for this class.
newBuilder(ClientContext clientContext)
public static EkmServiceSettings . Builder newBuilder ( ClientContext clientContext ) Returns a new builder for this class.
newHttpJsonBuilder()
public static EkmServiceSettings . Builder newHttpJsonBuilder () Beta
This feature is covered by the Pre-GA Offerings Terms of the Terms of Service. Pre-GA libraries might have limited support, and changes to pre-GA libraries might not be compatible with other pre-GA versions. For more information, see the launch stage descriptions.
Returns a new REST builder for this class.
Constructors EkmServiceSettings(EkmServiceSettings.Builder settingsBuilder)
protected EkmServiceSettings ( EkmServiceSettings . Builder settingsBuilder ) Methods createEkmConnectionSettings()
public UnaryCallSettings<CreateEkmConnectionRequest , EkmConnection > createEkmConnectionSettings () Returns the object with the settings used for calls to createEkmConnection.
getEkmConfigSettings()
public UnaryCallSettings<GetEkmConfigRequest , EkmConfig > getEkmConfigSettings () Returns the object with the settings used for calls to getEkmConfig.
getEkmConnectionSettings()
public UnaryCallSettings<GetEkmConnectionRequest , EkmConnection > getEkmConnectionSettings () Returns the object with the settings used for calls to getEkmConnection.
getIamPolicySettings()
public UnaryCallSettings<GetIamPolicyRequest , Policy > getIamPolicySettings () Returns the object with the settings used for calls to getIamPolicy.
Returns Type Description UnaryCallSettings <com.google.iam.v1.GetIamPolicyRequest ,com.google.iam.v1.Policy >
getLocationSettings()
public UnaryCallSettings<GetLocationRequest , Location > getLocationSettings () Returns the object with the settings used for calls to getLocation.
Returns Type Description UnaryCallSettings <com.google.cloud.location.GetLocationRequest ,com.google.cloud.location.Location >
listEkmConnectionsSettings()
public PagedCallSettings<ListEkmConnectionsRequest , ListEkmConnectionsResponse , EkmServiceClient . ListEkmConnectionsPagedResponse > listEkmConnectionsSettings () Returns the object with the settings used for calls to listEkmConnections.
listLocationsSettings()
public PagedCallSettings<ListLocationsRequest , ListLocationsResponse , EkmServiceClient . ListLocationsPagedResponse > listLocationsSettings () Returns the object with the settings used for calls to listLocations.
setIamPolicySettings()
public UnaryCallSettings<SetIamPolicyRequest , Policy > setIamPolicySettings () Returns the object with the settings used for calls to setIamPolicy.
Returns Type Description UnaryCallSettings <com.google.iam.v1.SetIamPolicyRequest ,com.google.iam.v1.Policy >
testIamPermissionsSettings()
public UnaryCallSettings<TestIamPermissionsRequest , TestIamPermissionsResponse > testIamPermissionsSettings () Returns the object with the settings used for calls to testIamPermissions.
Returns Type Description UnaryCallSettings <com.google.iam.v1.TestIamPermissionsRequest ,com.google.iam.v1.TestIamPermissionsResponse >
toBuilder()
public EkmServiceSettings . Builder toBuilder () Returns a builder containing all the values of this settings class.
Overrides updateEkmConfigSettings()
public UnaryCallSettings<UpdateEkmConfigRequest , EkmConfig > updateEkmConfigSettings () Returns the object with the settings used for calls to updateEkmConfig.
updateEkmConnectionSettings()
public UnaryCallSettings<UpdateEkmConnectionRequest , EkmConnection > updateEkmConnectionSettings () Returns the object with the settings used for calls to updateEkmConnection.
verifyConnectivitySettings()
public UnaryCallSettings<VerifyConnectivityRequest , VerifyConnectivityResponse > verifyConnectivitySettings () Returns the object with the settings used for calls to verifyConnectivity.
Send feedback
Except as otherwise noted, the content of this page is licensed under the Creative Commons Attribution 4.0 License , and code samples are licensed under the Apache 2.0 License . For details, see the Google Developers Site Policies . Java is a registered trademark of Oracle and/or its affiliates.
Last updated 2025-06-12 UTC.
Need to tell us more? [[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Hard to understand","hardToUnderstand","thumb-down"],["Incorrect information or sample code","incorrectInformationOrSampleCode","thumb-down"],["Missing the information/samples I need","missingTheInformationSamplesINeed","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2025-06-12 UTC."],[],[]]