Class EssentialContactsServiceSettings (2.3.0)

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 total timeout of createContact to 30 seconds:


 // This snippet has been automatically generated for illustrative purposes only.
 // It may require modifications to work in your environment.
 EssentialContactsServiceSettings.Builder essentialContactsServiceSettingsBuilder =
     EssentialContactsServiceSettings.newBuilder();
 essentialContactsServiceSettingsBuilder
     .createContactSettings()
     .setRetrySettings(
         essentialContactsServiceSettingsBuilder
             .createContactSettings()
             .getRetrySettings()
             .toBuilder()
             .setTotalTimeout(Duration.ofSeconds(30))
             .build());
 EssentialContactsServiceSettings essentialContactsServiceSettings =
     essentialContactsServiceSettingsBuilder.build();

Inheritance

java.lang.Object > ClientSettings > EssentialContactsServiceSettings

Inherited Members

ClientSettings.<B>toBuilder()

ClientSettings.getBackgroundExecutorProvider()

ClientSettings.getClock()

ClientSettings.getCredentialsProvider()

ClientSettings.getEndpoint()

ClientSettings.getExecutorProvider()

ClientSettings.getHeaderProvider()

ClientSettings.getInternalHeaderProvider()

ClientSettings.getQuotaProjectId()

ClientSettings.getStubSettings()

ClientSettings.getTransportChannelProvider()

ClientSettings.getWatchdogCheckInterval()

ClientSettings.getWatchdogProvider()

ClientSettings.toString()

Object.clone()

Object.equals(Object)

Object.finalize()

Object.getClass()

Object.hashCode()

Object.notify()

Object.notifyAll()

Object.wait()

Object.wait(long)

Object.wait(long,int)

Static Methods

create(EssentialContactsServiceStubSettings stub)

public static final EssentialContactsServiceSettings create(EssentialContactsServiceStubSettings stub)

Parameter

Name	Description
stub	`EssentialContactsServiceStubSettings`

Returns

Type	Description
EssentialContactsServiceSettings

Exceptions

Type	Description
IOException

defaultApiClientHeaderProviderBuilder()

public static ApiClientHeaderProvider.Builder defaultApiClientHeaderProviderBuilder()

Returns

Type	Description
Builder

defaultCredentialsProviderBuilder()

public static GoogleCredentialsProvider.Builder defaultCredentialsProviderBuilder()

Returns a builder for the default credentials for this service.

Returns

Type	Description
Builder

defaultExecutorProviderBuilder()

public static InstantiatingExecutorProvider.Builder defaultExecutorProviderBuilder()

Returns a builder for the default ExecutorProvider for this service.

Returns

Type	Description
Builder

defaultGrpcTransportProviderBuilder()

public static InstantiatingGrpcChannelProvider.Builder defaultGrpcTransportProviderBuilder()

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

Returns

Type	Description
Builder

defaultHttpJsonTransportProviderBuilder()

public static InstantiatingHttpJsonChannelProvider.Builder defaultHttpJsonTransportProviderBuilder()

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

Returns

Type	Description
Builder

defaultTransportChannelProvider()

public static TransportChannelProvider defaultTransportChannelProvider()

Returns

Type	Description
TransportChannelProvider

getDefaultEndpoint()

public static String getDefaultEndpoint()

Returns the default service endpoint.

Returns

Type	Description
String

getDefaultServiceScopes()

public static List<String> getDefaultServiceScopes()

Returns the default service scopes.

Returns

Type	Description
List<String>

newBuilder()

public static EssentialContactsServiceSettings.Builder newBuilder()

Returns a new gRPC builder for this class.

Returns

Type	Description
EssentialContactsServiceSettings.Builder

newBuilder(ClientContext clientContext)

public static EssentialContactsServiceSettings.Builder newBuilder(ClientContext clientContext)

Returns a new builder for this class.

Parameter

Name	Description
clientContext	`ClientContext`

Returns

Type	Description
EssentialContactsServiceSettings.Builder

newHttpJsonBuilder()

public static EssentialContactsServiceSettings.Builder newHttpJsonBuilder()

Returns a new REST builder for this class.

Returns

Type	Description
EssentialContactsServiceSettings.Builder

Constructors

EssentialContactsServiceSettings(EssentialContactsServiceSettings.Builder settingsBuilder)

protected EssentialContactsServiceSettings(EssentialContactsServiceSettings.Builder settingsBuilder)

Parameter

Name	Description
settingsBuilder	`EssentialContactsServiceSettings.Builder`

Methods

computeContactsSettings()

public PagedCallSettings<ComputeContactsRequest,ComputeContactsResponse,EssentialContactsServiceClient.ComputeContactsPagedResponse> computeContactsSettings()

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

Returns

Type	Description
PagedCallSettings<ComputeContactsRequest,ComputeContactsResponse,ComputeContactsPagedResponse>

createContactSettings()

public UnaryCallSettings<CreateContactRequest,Contact> createContactSettings()

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

Returns

Type	Description
UnaryCallSettings<CreateContactRequest,Contact>

deleteContactSettings()

public UnaryCallSettings<DeleteContactRequest,Empty> deleteContactSettings()

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

Returns

Type	Description
UnaryCallSettings<DeleteContactRequest,Empty>

getContactSettings()

public UnaryCallSettings<GetContactRequest,Contact> getContactSettings()

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

Returns

Type	Description
UnaryCallSettings<GetContactRequest,Contact>

listContactsSettings()

public PagedCallSettings<ListContactsRequest,ListContactsResponse,EssentialContactsServiceClient.ListContactsPagedResponse> listContactsSettings()

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

Returns

Type	Description
PagedCallSettings<ListContactsRequest,ListContactsResponse,ListContactsPagedResponse>

sendTestMessageSettings()

public UnaryCallSettings<SendTestMessageRequest,Empty> sendTestMessageSettings()

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

Returns

Type	Description
UnaryCallSettings<SendTestMessageRequest,Empty>

toBuilder()

public EssentialContactsServiceSettings.Builder toBuilder()

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

Returns

Type	Description
EssentialContactsServiceSettings.Builder

Overrides

ClientSettings<SettingsT>.<B>toBuilder()

updateContactSettings()

public UnaryCallSettings<UpdateContactRequest,Contact> updateContactSettings()

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

Returns

Type	Description
UnaryCallSettings<UpdateContactRequest,Contact>