Class RecaptchaEnterpriseServiceSettings
- java.lang.Object
-
- com.google.api.gax.rpc.ClientSettings<RecaptchaEnterpriseServiceSettings>
-
- com.google.cloud.recaptchaenterprise.v1.RecaptchaEnterpriseServiceSettings
-
@Generated("by gapic-generator-java") public class RecaptchaEnterpriseServiceSettings extends com.google.api.gax.rpc.ClientSettings<RecaptchaEnterpriseServiceSettings>
Settings class to configure an instance ofRecaptchaEnterpriseServiceClient
.The default instance has everything set to sensible defaults:
- The default service address (recaptchaenterprise.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 createAssessment 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 RecaptchaEnterpriseServiceSettings.Builder recaptchaEnterpriseServiceSettingsBuilder = RecaptchaEnterpriseServiceSettings.newBuilder(); recaptchaEnterpriseServiceSettingsBuilder .createAssessmentSettings() .setRetrySettings( recaptchaEnterpriseServiceSettingsBuilder .createAssessmentSettings() .getRetrySettings() .toBuilder() .setTotalTimeout(Duration.ofSeconds(30)) .build()); RecaptchaEnterpriseServiceSettings recaptchaEnterpriseServiceSettings = recaptchaEnterpriseServiceSettingsBuilder.build();
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static class
RecaptchaEnterpriseServiceSettings.Builder
Builder for RecaptchaEnterpriseServiceSettings.
-
Constructor Summary
Constructors Modifier Constructor Description protected
RecaptchaEnterpriseServiceSettings(RecaptchaEnterpriseServiceSettings.Builder settingsBuilder)
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description com.google.api.gax.rpc.UnaryCallSettings<AnnotateAssessmentRequest,AnnotateAssessmentResponse>
annotateAssessmentSettings()
Returns the object with the settings used for calls to annotateAssessment.static RecaptchaEnterpriseServiceSettings
create(RecaptchaEnterpriseServiceStubSettings stub)
com.google.api.gax.rpc.UnaryCallSettings<CreateAssessmentRequest,Assessment>
createAssessmentSettings()
Returns the object with the settings used for calls to createAssessment.com.google.api.gax.rpc.UnaryCallSettings<CreateKeyRequest,Key>
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 ChannelProvider for this service.static com.google.api.gax.rpc.TransportChannelProvider
defaultTransportChannelProvider()
com.google.api.gax.rpc.UnaryCallSettings<DeleteKeyRequest,com.google.protobuf.Empty>
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<GetMetricsRequest,Metrics>
getMetricsSettings()
Returns the object with the settings used for calls to getMetrics.com.google.api.gax.rpc.PagedCallSettings<ListKeysRequest,ListKeysResponse,RecaptchaEnterpriseServiceClient.ListKeysPagedResponse>
listKeysSettings()
Returns the object with the settings used for calls to listKeys.com.google.api.gax.rpc.PagedCallSettings<ListRelatedAccountGroupMembershipsRequest,ListRelatedAccountGroupMembershipsResponse,RecaptchaEnterpriseServiceClient.ListRelatedAccountGroupMembershipsPagedResponse>
listRelatedAccountGroupMembershipsSettings()
Returns the object with the settings used for calls to listRelatedAccountGroupMemberships.com.google.api.gax.rpc.PagedCallSettings<ListRelatedAccountGroupsRequest,ListRelatedAccountGroupsResponse,RecaptchaEnterpriseServiceClient.ListRelatedAccountGroupsPagedResponse>
listRelatedAccountGroupsSettings()
Returns the object with the settings used for calls to listRelatedAccountGroups.com.google.api.gax.rpc.UnaryCallSettings<MigrateKeyRequest,Key>
migrateKeySettings()
Returns the object with the settings used for calls to migrateKey.static RecaptchaEnterpriseServiceSettings.Builder
newBuilder()
Returns a new builder for this class.static RecaptchaEnterpriseServiceSettings.Builder
newBuilder(com.google.api.gax.rpc.ClientContext clientContext)
Returns a new builder for this class.com.google.api.gax.rpc.UnaryCallSettings<RetrieveLegacySecretKeyRequest,RetrieveLegacySecretKeyResponse>
retrieveLegacySecretKeySettings()
Returns the object with the settings used for calls to retrieveLegacySecretKey.com.google.api.gax.rpc.PagedCallSettings<SearchRelatedAccountGroupMembershipsRequest,SearchRelatedAccountGroupMembershipsResponse,RecaptchaEnterpriseServiceClient.SearchRelatedAccountGroupMembershipsPagedResponse>
searchRelatedAccountGroupMembershipsSettings()
Returns the object with the settings used for calls to searchRelatedAccountGroupMemberships.RecaptchaEnterpriseServiceSettings.Builder
toBuilder()
Returns a builder containing all the values of this settings class.com.google.api.gax.rpc.UnaryCallSettings<UpdateKeyRequest,Key>
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, getWatchdogCheckInterval, getWatchdogProvider, toString
-
-
-
-
Constructor Detail
-
RecaptchaEnterpriseServiceSettings
protected RecaptchaEnterpriseServiceSettings(RecaptchaEnterpriseServiceSettings.Builder settingsBuilder) throws IOException
- Throws:
IOException
-
-
Method Detail
-
createAssessmentSettings
public com.google.api.gax.rpc.UnaryCallSettings<CreateAssessmentRequest,Assessment> createAssessmentSettings()
Returns the object with the settings used for calls to createAssessment.
-
annotateAssessmentSettings
public com.google.api.gax.rpc.UnaryCallSettings<AnnotateAssessmentRequest,AnnotateAssessmentResponse> annotateAssessmentSettings()
Returns the object with the settings used for calls to annotateAssessment.
-
createKeySettings
public com.google.api.gax.rpc.UnaryCallSettings<CreateKeyRequest,Key> createKeySettings()
Returns the object with the settings used for calls to createKey.
-
listKeysSettings
public com.google.api.gax.rpc.PagedCallSettings<ListKeysRequest,ListKeysResponse,RecaptchaEnterpriseServiceClient.ListKeysPagedResponse> listKeysSettings()
Returns the object with the settings used for calls to listKeys.
-
retrieveLegacySecretKeySettings
public com.google.api.gax.rpc.UnaryCallSettings<RetrieveLegacySecretKeyRequest,RetrieveLegacySecretKeyResponse> retrieveLegacySecretKeySettings()
Returns the object with the settings used for calls to retrieveLegacySecretKey.
-
getKeySettings
public com.google.api.gax.rpc.UnaryCallSettings<GetKeyRequest,Key> getKeySettings()
Returns the object with the settings used for calls to getKey.
-
updateKeySettings
public com.google.api.gax.rpc.UnaryCallSettings<UpdateKeyRequest,Key> updateKeySettings()
Returns the object with the settings used for calls to updateKey.
-
deleteKeySettings
public com.google.api.gax.rpc.UnaryCallSettings<DeleteKeyRequest,com.google.protobuf.Empty> deleteKeySettings()
Returns the object with the settings used for calls to deleteKey.
-
migrateKeySettings
public com.google.api.gax.rpc.UnaryCallSettings<MigrateKeyRequest,Key> migrateKeySettings()
Returns the object with the settings used for calls to migrateKey.
-
getMetricsSettings
public com.google.api.gax.rpc.UnaryCallSettings<GetMetricsRequest,Metrics> getMetricsSettings()
Returns the object with the settings used for calls to getMetrics.
-
listRelatedAccountGroupsSettings
public com.google.api.gax.rpc.PagedCallSettings<ListRelatedAccountGroupsRequest,ListRelatedAccountGroupsResponse,RecaptchaEnterpriseServiceClient.ListRelatedAccountGroupsPagedResponse> listRelatedAccountGroupsSettings()
Returns the object with the settings used for calls to listRelatedAccountGroups.
-
listRelatedAccountGroupMembershipsSettings
public com.google.api.gax.rpc.PagedCallSettings<ListRelatedAccountGroupMembershipsRequest,ListRelatedAccountGroupMembershipsResponse,RecaptchaEnterpriseServiceClient.ListRelatedAccountGroupMembershipsPagedResponse> listRelatedAccountGroupMembershipsSettings()
Returns the object with the settings used for calls to listRelatedAccountGroupMemberships.
-
searchRelatedAccountGroupMembershipsSettings
public com.google.api.gax.rpc.PagedCallSettings<SearchRelatedAccountGroupMembershipsRequest,SearchRelatedAccountGroupMembershipsResponse,RecaptchaEnterpriseServiceClient.SearchRelatedAccountGroupMembershipsPagedResponse> searchRelatedAccountGroupMembershipsSettings()
Returns the object with the settings used for calls to searchRelatedAccountGroupMemberships.
-
create
public static final RecaptchaEnterpriseServiceSettings create(RecaptchaEnterpriseServiceStubSettings 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 ChannelProvider for this service.
-
defaultTransportChannelProvider
public static com.google.api.gax.rpc.TransportChannelProvider defaultTransportChannelProvider()
-
defaultApiClientHeaderProviderBuilder
@BetaApi("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 RecaptchaEnterpriseServiceSettings.Builder newBuilder()
Returns a new builder for this class.
-
newBuilder
public static RecaptchaEnterpriseServiceSettings.Builder newBuilder(com.google.api.gax.rpc.ClientContext clientContext)
Returns a new builder for this class.
-
toBuilder
public RecaptchaEnterpriseServiceSettings.Builder toBuilder()
Returns a builder containing all the values of this settings class.- Specified by:
toBuilder
in classcom.google.api.gax.rpc.ClientSettings<RecaptchaEnterpriseServiceSettings>
-
-