Class ApiKeysSettings (0.20.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 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();

Inheritance

java.lang.Object > ClientSettings > ApiKeysSettings

Static Methods

create(ApiKeysStubSettings stub)

public static final ApiKeysSettings create(ApiKeysStubSettings stub)
Parameter
NameDescription
stubApiKeysStubSettings
Returns
TypeDescription
ApiKeysSettings
Exceptions
TypeDescription
IOException

defaultApiClientHeaderProviderBuilder()

public static ApiClientHeaderProvider.Builder defaultApiClientHeaderProviderBuilder()
Returns
TypeDescription
Builder

defaultCredentialsProviderBuilder()

public static GoogleCredentialsProvider.Builder defaultCredentialsProviderBuilder()

Returns a builder for the default credentials for this service.

Returns
TypeDescription
Builder

defaultExecutorProviderBuilder()

public static InstantiatingExecutorProvider.Builder defaultExecutorProviderBuilder()

Returns a builder for the default ExecutorProvider for this service.

Returns
TypeDescription
Builder

defaultGrpcTransportProviderBuilder()

public static InstantiatingGrpcChannelProvider.Builder defaultGrpcTransportProviderBuilder()

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

Returns
TypeDescription
Builder

defaultHttpJsonTransportProviderBuilder()

public static InstantiatingHttpJsonChannelProvider.Builder defaultHttpJsonTransportProviderBuilder()

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

Returns
TypeDescription
Builder

defaultTransportChannelProvider()

public static TransportChannelProvider defaultTransportChannelProvider()
Returns
TypeDescription
TransportChannelProvider

getDefaultEndpoint()

public static String getDefaultEndpoint()

Returns the default service endpoint.

Returns
TypeDescription
String

getDefaultServiceScopes()

public static List<String> getDefaultServiceScopes()

Returns the default service scopes.

Returns
TypeDescription
List<String>

newBuilder()

public static ApiKeysSettings.Builder newBuilder()

Returns a new gRPC builder for this class.

Returns
TypeDescription
ApiKeysSettings.Builder

newBuilder(ClientContext clientContext)

public static ApiKeysSettings.Builder newBuilder(ClientContext clientContext)

Returns a new builder for this class.

Parameter
NameDescription
clientContextClientContext
Returns
TypeDescription
ApiKeysSettings.Builder

newHttpJsonBuilder()

public static ApiKeysSettings.Builder newHttpJsonBuilder()

Returns a new REST builder for this class.

Returns
TypeDescription
ApiKeysSettings.Builder

Constructors

ApiKeysSettings(ApiKeysSettings.Builder settingsBuilder)

protected ApiKeysSettings(ApiKeysSettings.Builder settingsBuilder)
Parameter
NameDescription
settingsBuilderApiKeysSettings.Builder

Methods

createKeyOperationSettings()

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

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

Returns
TypeDescription
OperationCallSettings<CreateKeyRequest,Key,Empty>

createKeySettings()

public UnaryCallSettings<CreateKeyRequest,Operation> createKeySettings()

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

Returns
TypeDescription
UnaryCallSettings<CreateKeyRequest,Operation>

deleteKeyOperationSettings()

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

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

Returns
TypeDescription
OperationCallSettings<DeleteKeyRequest,Key,Empty>

deleteKeySettings()

public UnaryCallSettings<DeleteKeyRequest,Operation> deleteKeySettings()

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

Returns
TypeDescription
UnaryCallSettings<DeleteKeyRequest,Operation>

getKeySettings()

public UnaryCallSettings<GetKeyRequest,Key> getKeySettings()

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

Returns
TypeDescription
UnaryCallSettings<GetKeyRequest,Key>

getKeyStringSettings()

public UnaryCallSettings<GetKeyStringRequest,GetKeyStringResponse> getKeyStringSettings()

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

Returns
TypeDescription
UnaryCallSettings<GetKeyStringRequest,GetKeyStringResponse>

listKeysSettings()

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

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

Returns
TypeDescription
PagedCallSettings<ListKeysRequest,ListKeysResponse,ListKeysPagedResponse>

lookupKeySettings()

public UnaryCallSettings<LookupKeyRequest,LookupKeyResponse> lookupKeySettings()

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

Returns
TypeDescription
UnaryCallSettings<LookupKeyRequest,LookupKeyResponse>

toBuilder()

public ApiKeysSettings.Builder toBuilder()

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

Returns
TypeDescription
ApiKeysSettings.Builder
Overrides

undeleteKeyOperationSettings()

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

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

Returns
TypeDescription
OperationCallSettings<UndeleteKeyRequest,Key,Empty>

undeleteKeySettings()

public UnaryCallSettings<UndeleteKeyRequest,Operation> undeleteKeySettings()

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

Returns
TypeDescription
UnaryCallSettings<UndeleteKeyRequest,Operation>

updateKeyOperationSettings()

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

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

Returns
TypeDescription
OperationCallSettings<UpdateKeyRequest,Key,Empty>

updateKeySettings()

public UnaryCallSettings<UpdateKeyRequest,Operation> updateKeySettings()

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

Returns
TypeDescription
UnaryCallSettings<UpdateKeyRequest,Operation>