com.google.api.apikeys.v2

Class ApiKeysSettings

java.lang.Object

com.google.api.gax.rpc.ClientSettings<ApiKeysSettings>

com.google.api.apikeys.v2.ApiKeysSettings

@Generated(value="by gapic-generator-java")
public class ApiKeysSettings
extends com.google.api.gax.rpc.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();
 

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	ApiKeysSettings.Builder Builder for ApiKeysSettings.

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	ApiKeysSettings(ApiKeysSettings.Builder settingsBuilder)

Method Summary

Modifier and Type	Method and Description
static ApiKeysSettings	create(ApiKeysStubSettings stub)
com.google.api.gax.rpc.OperationCallSettings<CreateKeyRequest,Key,com.google.protobuf.Empty>	createKeyOperationSettings() Returns the object with the settings used for calls to createKey.
com.google.api.gax.rpc.UnaryCallSettings<CreateKeyRequest,com.google.longrunning.Operation>	createKeySettings() Returns the object with the settings used for calls to createKey.
static com.google.api.gax.rpc.ApiClientHeaderProvider.Builder	defaultApiClientHeaderProviderBuilder()
static com.google.api.gax.core.GoogleCredentialsProvider.Builder	defaultCredentialsProviderBuilder() Returns a builder for the default credentials for this service.
static com.google.api.gax.core.InstantiatingExecutorProvider.Builder	defaultExecutorProviderBuilder() Returns a builder for the default ExecutorProvider for this service.
static com.google.api.gax.grpc.InstantiatingGrpcChannelProvider.Builder	defaultGrpcTransportProviderBuilder() Returns a builder for the default gRPC ChannelProvider for this service.
static com.google.api.gax.httpjson.InstantiatingHttpJsonChannelProvider.Builder	defaultHttpJsonTransportProviderBuilder() Returns a builder for the default REST ChannelProvider for this service.
static com.google.api.gax.rpc.TransportChannelProvider	defaultTransportChannelProvider()
com.google.api.gax.rpc.OperationCallSettings<DeleteKeyRequest,Key,com.google.protobuf.Empty>	deleteKeyOperationSettings() Returns the object with the settings used for calls to deleteKey.
com.google.api.gax.rpc.UnaryCallSettings<DeleteKeyRequest,com.google.longrunning.Operation>	deleteKeySettings() Returns the object with the settings used for calls to deleteKey.
static String	getDefaultEndpoint() Returns the default service endpoint.
static List<String>	getDefaultServiceScopes() Returns the default service scopes.
com.google.api.gax.rpc.UnaryCallSettings<GetKeyRequest,Key>	getKeySettings() Returns the object with the settings used for calls to getKey.
com.google.api.gax.rpc.UnaryCallSettings<GetKeyStringRequest,GetKeyStringResponse>	getKeyStringSettings() Returns the object with the settings used for calls to getKeyString.
com.google.api.gax.rpc.PagedCallSettings<ListKeysRequest,ListKeysResponse,ApiKeysClient.ListKeysPagedResponse>	listKeysSettings() Returns the object with the settings used for calls to listKeys.
com.google.api.gax.rpc.UnaryCallSettings<LookupKeyRequest,LookupKeyResponse>	lookupKeySettings() Returns the object with the settings used for calls to lookupKey.
static ApiKeysSettings.Builder	newBuilder() Returns a new gRPC builder for this class.
static ApiKeysSettings.Builder	newBuilder(com.google.api.gax.rpc.ClientContext clientContext) Returns a new builder for this class.
static ApiKeysSettings.Builder	newHttpJsonBuilder() Returns a new REST builder for this class.
ApiKeysSettings.Builder	toBuilder() Returns a builder containing all the values of this settings class.
com.google.api.gax.rpc.OperationCallSettings<UndeleteKeyRequest,Key,com.google.protobuf.Empty>	undeleteKeyOperationSettings() Returns the object with the settings used for calls to undeleteKey.
com.google.api.gax.rpc.UnaryCallSettings<UndeleteKeyRequest,com.google.longrunning.Operation>	undeleteKeySettings() Returns the object with the settings used for calls to undeleteKey.
com.google.api.gax.rpc.OperationCallSettings<UpdateKeyRequest,Key,com.google.protobuf.Empty>	updateKeyOperationSettings() Returns the object with the settings used for calls to updateKey.
com.google.api.gax.rpc.UnaryCallSettings<UpdateKeyRequest,com.google.longrunning.Operation>	updateKeySettings() Returns the object with the settings used for calls to updateKey.

Methods inherited from class com.google.api.gax.rpc.ClientSettings

getBackgroundExecutorProvider, getClock, getCredentialsProvider, getEndpoint, getExecutorProvider, getGdchApiAudience, getHeaderProvider, getInternalHeaderProvider, getQuotaProjectId, getStubSettings, getTransportChannelProvider, getUniverseDomain, getWatchdogCheckInterval, getWatchdogProvider, toString

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

ApiKeysSettings

protected ApiKeysSettings(ApiKeysSettings.Builder settingsBuilder)
                   throws IOException

Throws:

IOException

Method Detail

createKeySettings

public com.google.api.gax.rpc.UnaryCallSettings<CreateKeyRequest,com.google.longrunning.Operation> createKeySettings()

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

createKeyOperationSettings

public com.google.api.gax.rpc.OperationCallSettings<CreateKeyRequest,Key,com.google.protobuf.Empty> createKeyOperationSettings()

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

listKeysSettings

public com.google.api.gax.rpc.PagedCallSettings<ListKeysRequest,ListKeysResponse,ApiKeysClient.ListKeysPagedResponse> listKeysSettings()

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

getKeySettings

public com.google.api.gax.rpc.UnaryCallSettings<GetKeyRequest,Key> getKeySettings()

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

getKeyStringSettings

public com.google.api.gax.rpc.UnaryCallSettings<GetKeyStringRequest,GetKeyStringResponse> getKeyStringSettings()

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

updateKeySettings

public com.google.api.gax.rpc.UnaryCallSettings<UpdateKeyRequest,com.google.longrunning.Operation> updateKeySettings()

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

updateKeyOperationSettings

public com.google.api.gax.rpc.OperationCallSettings<UpdateKeyRequest,Key,com.google.protobuf.Empty> updateKeyOperationSettings()

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

deleteKeySettings

public com.google.api.gax.rpc.UnaryCallSettings<DeleteKeyRequest,com.google.longrunning.Operation> deleteKeySettings()

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

deleteKeyOperationSettings

public com.google.api.gax.rpc.OperationCallSettings<DeleteKeyRequest,Key,com.google.protobuf.Empty> deleteKeyOperationSettings()

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

undeleteKeySettings

public com.google.api.gax.rpc.UnaryCallSettings<UndeleteKeyRequest,com.google.longrunning.Operation> undeleteKeySettings()

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

undeleteKeyOperationSettings

public com.google.api.gax.rpc.OperationCallSettings<UndeleteKeyRequest,Key,com.google.protobuf.Empty> undeleteKeyOperationSettings()

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

lookupKeySettings

public com.google.api.gax.rpc.UnaryCallSettings<LookupKeyRequest,LookupKeyResponse> lookupKeySettings()

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

create

public static final ApiKeysSettings create(ApiKeysStubSettings stub)
                                    throws IOException

Throws:

IOException

defaultExecutorProviderBuilder

public static com.google.api.gax.core.InstantiatingExecutorProvider.Builder defaultExecutorProviderBuilder()

Returns a builder for the default ExecutorProvider for this service.

getDefaultEndpoint

public static String getDefaultEndpoint()

Returns the default service endpoint.

getDefaultServiceScopes

public static List<String> getDefaultServiceScopes()

Returns the default service scopes.

defaultCredentialsProviderBuilder

public static com.google.api.gax.core.GoogleCredentialsProvider.Builder defaultCredentialsProviderBuilder()

Returns a builder for the default credentials for this service.

defaultGrpcTransportProviderBuilder

public static com.google.api.gax.grpc.InstantiatingGrpcChannelProvider.Builder defaultGrpcTransportProviderBuilder()

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

defaultHttpJsonTransportProviderBuilder

@BetaApi
public static com.google.api.gax.httpjson.InstantiatingHttpJsonChannelProvider.Builder defaultHttpJsonTransportProviderBuilder()

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

defaultTransportChannelProvider

public static com.google.api.gax.rpc.TransportChannelProvider defaultTransportChannelProvider()

defaultApiClientHeaderProviderBuilder

@BetaApi(value="The surface for customizing headers is not stable yet and may change in the future.")
public static com.google.api.gax.rpc.ApiClientHeaderProvider.Builder defaultApiClientHeaderProviderBuilder()

newBuilder

public static ApiKeysSettings.Builder newBuilder()

Returns a new gRPC builder for this class.

newHttpJsonBuilder

@BetaApi
public static ApiKeysSettings.Builder newHttpJsonBuilder()

Returns a new REST builder for this class.

newBuilder

public static ApiKeysSettings.Builder newBuilder(com.google.api.gax.rpc.ClientContext clientContext)

Returns a new builder for this class.

toBuilder

public ApiKeysSettings.Builder toBuilder()

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

Specified by:

toBuilder in class com.google.api.gax.rpc.ClientSettings<ApiKeysSettings>