Class EssentialContactsServiceSettings
java.lang.Object
com.google.api.gax.rpc.ClientSettings<EssentialContactsServiceSettings>
com.google.cloud.essentialcontacts.v1.EssentialContactsServiceSettings
@Generated("by gapic-generator-java")
public class EssentialContactsServiceSettings
extends ClientSettings<EssentialContactsServiceSettings>
Settings class to configure an instance of
EssentialContactsServiceClient.
The default instance has everything set to sensible defaults:
- The default service address (essentialcontacts.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 [RetrySettings](https://cloud.google.com/java/docs/reference/gax/latest/com.google.api.gax.retrying.RetrySettings) of createContact:
// 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
EssentialContactsServiceSettings.Builder essentialContactsServiceSettingsBuilder =
EssentialContactsServiceSettings.newBuilder();
essentialContactsServiceSettingsBuilder
.createContactSettings()
.setRetrySettings(
essentialContactsServiceSettingsBuilder
.createContactSettings()
.getRetrySettings()
.toBuilder()
.setInitialRetryDelayDuration(Duration.ofSeconds(1))
.setInitialRpcTimeoutDuration(Duration.ofSeconds(5))
.setMaxAttempts(5)
.setMaxRetryDelayDuration(Duration.ofSeconds(30))
.setMaxRpcTimeoutDuration(Duration.ofSeconds(60))
.setRetryDelayMultiplier(1.3)
.setRpcTimeoutMultiplier(1.5)
.setTotalTimeoutDuration(Duration.ofSeconds(300))
.build());
EssentialContactsServiceSettings essentialContactsServiceSettings =
essentialContactsServiceSettingsBuilder.build();
Please refer to the [Client Side Retry
Guide](https://docs.cloud.google.com/java/docs/client-retries) for additional support in setting
retries.-
Nested Class Summary
Nested ClassesModifier and TypeClassDescriptionstatic classBuilder for EssentialContactsServiceSettings. -
Constructor Summary
ConstructorsModifierConstructorDescriptionprotectedEssentialContactsServiceSettings(EssentialContactsServiceSettings.Builder settingsBuilder) -
Method Summary
Modifier and TypeMethodDescriptionPagedCallSettings<ComputeContactsRequest,ComputeContactsResponse, EssentialContactsServiceClient.ComputeContactsPagedResponse> Returns the object with the settings used for calls to computeContacts.static final EssentialContactsServiceSettingsReturns the object with the settings used for calls to createContact.Returns a builder for the default credentials for this service.Returns a builder for the default ExecutorProvider for this service.Returns a builder for the default gRPC ChannelProvider for this service.Returns a builder for the default REST ChannelProvider for this service.static TransportChannelProviderUnaryCallSettings<DeleteContactRequest,com.google.protobuf.Empty> Returns the object with the settings used for calls to deleteContact.Returns the object with the settings used for calls to getContact.static StringReturns the default service endpoint.Returns the default service scopes.PagedCallSettings<ListContactsRequest,ListContactsResponse, EssentialContactsServiceClient.ListContactsPagedResponse> Returns the object with the settings used for calls to listContacts.Returns a new gRPC builder for this class.newBuilder(ClientContext clientContext) Returns a new builder for this class.Returns a new REST builder for this class.UnaryCallSettings<SendTestMessageRequest,com.google.protobuf.Empty> Returns the object with the settings used for calls to sendTestMessage.Returns a builder containing all the values of this settings class.Returns the object with the settings used for calls to updateContact.Methods inherited from class com.google.api.gax.rpc.ClientSettings
getApiKey, getBackgroundExecutorProvider, getClock, getCredentialsProvider, getEndpoint, getExecutorProvider, getGdchApiAudience, getHeaderProvider, getInternalHeaderProvider, getQuotaProjectId, getStubSettings, getTransportChannelProvider, getUniverseDomain, getWatchdogCheckInterval, getWatchdogCheckIntervalDuration, getWatchdogProvider, toString
-
Constructor Details
-
EssentialContactsServiceSettings
protected EssentialContactsServiceSettings(EssentialContactsServiceSettings.Builder settingsBuilder) throws IOException - Throws:
IOException
-
-
Method Details
-
createContactSettings
Returns the object with the settings used for calls to createContact. -
updateContactSettings
Returns the object with the settings used for calls to updateContact. -
listContactsSettings
public PagedCallSettings<ListContactsRequest,ListContactsResponse, listContactsSettings()EssentialContactsServiceClient.ListContactsPagedResponse> Returns the object with the settings used for calls to listContacts. -
getContactSettings
Returns the object with the settings used for calls to getContact. -
deleteContactSettings
Returns the object with the settings used for calls to deleteContact. -
computeContactsSettings
public PagedCallSettings<ComputeContactsRequest,ComputeContactsResponse, computeContactsSettings()EssentialContactsServiceClient.ComputeContactsPagedResponse> Returns the object with the settings used for calls to computeContacts. -
sendTestMessageSettings
public UnaryCallSettings<SendTestMessageRequest,com.google.protobuf.Empty> sendTestMessageSettings()Returns the object with the settings used for calls to sendTestMessage. -
create
public static final EssentialContactsServiceSettings create(EssentialContactsServiceStubSettings stub) throws IOException - Throws:
IOException
-
defaultExecutorProviderBuilder
Returns a builder for the default ExecutorProvider for this service. -
getDefaultEndpoint
Returns the default service endpoint. -
getDefaultServiceScopes
Returns the default service scopes. -
defaultCredentialsProviderBuilder
Returns a builder for the default credentials for this service. -
defaultGrpcTransportProviderBuilder
Returns a builder for the default gRPC ChannelProvider for this service. -
defaultHttpJsonTransportProviderBuilder
@BetaApi public static InstantiatingHttpJsonChannelProvider.Builder defaultHttpJsonTransportProviderBuilder()Returns a builder for the default REST ChannelProvider for this service. -
defaultTransportChannelProvider
-
defaultApiClientHeaderProviderBuilder
-
newBuilder
Returns a new gRPC builder for this class. -
newHttpJsonBuilder
Returns a new REST builder for this class. -
newBuilder
Returns a new builder for this class. -
toBuilder
Returns a builder containing all the values of this settings class.- Specified by:
toBuilderin classClientSettings<EssentialContactsServiceSettings>
-