Class ReachabilityServiceSettings (1.12.0)

public class ReachabilityServiceSettings extends ClientSettings<ReachabilityServiceSettings>

Settings class to configure an instance of ReachabilityServiceClient.

The default instance has everything set to sensible defaults:

The default service address (networkmanagement.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 getConnectivityTest 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
 ReachabilityServiceSettings.Builder reachabilityServiceSettingsBuilder =
     ReachabilityServiceSettings.newBuilder();
 reachabilityServiceSettingsBuilder
     .getConnectivityTestSettings()
     .setRetrySettings(
         reachabilityServiceSettingsBuilder
             .getConnectivityTestSettings()
             .getRetrySettings()
             .toBuilder()
             .setTotalTimeout(Duration.ofSeconds(30))
             .build());
 ReachabilityServiceSettings reachabilityServiceSettings =
     reachabilityServiceSettingsBuilder.build();

Inheritance

java.lang.Object > ClientSettings > ReachabilityServiceSettings

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(ReachabilityServiceStubSettings stub)

public static final ReachabilityServiceSettings create(ReachabilityServiceStubSettings stub)

Parameter

Name	Description
`stub`	`ReachabilityServiceStubSettings`

Returns

Type	Description
`ReachabilityServiceSettings`

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 ReachabilityServiceSettings.Builder newBuilder()

Returns a new gRPC builder for this class.

Returns

Type	Description
`ReachabilityServiceSettings.Builder`

newBuilder(ClientContext clientContext)

public static ReachabilityServiceSettings.Builder newBuilder(ClientContext clientContext)

Returns a new builder for this class.

Parameter

Name	Description
`clientContext`	`ClientContext`

Returns

Type	Description
`ReachabilityServiceSettings.Builder`

newHttpJsonBuilder()

public static ReachabilityServiceSettings.Builder newHttpJsonBuilder()

Returns a new REST builder for this class.

Returns

Type	Description
`ReachabilityServiceSettings.Builder`

Constructors

ReachabilityServiceSettings(ReachabilityServiceSettings.Builder settingsBuilder)

protected ReachabilityServiceSettings(ReachabilityServiceSettings.Builder settingsBuilder)

Parameter

Name	Description
`settingsBuilder`	`ReachabilityServiceSettings.Builder`

Methods

createConnectivityTestOperationSettings()

public OperationCallSettings<CreateConnectivityTestRequest,ConnectivityTest,OperationMetadata> createConnectivityTestOperationSettings()

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

Returns

Type	Description
`OperationCallSettings<CreateConnectivityTestRequest,ConnectivityTest,OperationMetadata>`

createConnectivityTestSettings()

public UnaryCallSettings<CreateConnectivityTestRequest,Operation> createConnectivityTestSettings()

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

Returns

Type	Description
`UnaryCallSettings<CreateConnectivityTestRequest,Operation>`

deleteConnectivityTestOperationSettings()

public OperationCallSettings<DeleteConnectivityTestRequest,Empty,OperationMetadata> deleteConnectivityTestOperationSettings()

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

Returns

Type	Description
`OperationCallSettings<DeleteConnectivityTestRequest,Empty,OperationMetadata>`

deleteConnectivityTestSettings()

public UnaryCallSettings<DeleteConnectivityTestRequest,Operation> deleteConnectivityTestSettings()

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

Returns

Type	Description
`UnaryCallSettings<DeleteConnectivityTestRequest,Operation>`

getConnectivityTestSettings()

public UnaryCallSettings<GetConnectivityTestRequest,ConnectivityTest> getConnectivityTestSettings()

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

Returns

Type	Description
`UnaryCallSettings<GetConnectivityTestRequest,ConnectivityTest>`

listConnectivityTestsSettings()

public PagedCallSettings<ListConnectivityTestsRequest,ListConnectivityTestsResponse,ReachabilityServiceClient.ListConnectivityTestsPagedResponse> listConnectivityTestsSettings()

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

Returns

Type	Description
`PagedCallSettings<ListConnectivityTestsRequest,ListConnectivityTestsResponse,ListConnectivityTestsPagedResponse>`

rerunConnectivityTestOperationSettings()

public OperationCallSettings<RerunConnectivityTestRequest,ConnectivityTest,OperationMetadata> rerunConnectivityTestOperationSettings()

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

Returns

Type	Description
`OperationCallSettings<RerunConnectivityTestRequest,ConnectivityTest,OperationMetadata>`

rerunConnectivityTestSettings()

public UnaryCallSettings<RerunConnectivityTestRequest,Operation> rerunConnectivityTestSettings()

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

Returns

Type	Description
`UnaryCallSettings<RerunConnectivityTestRequest,Operation>`

toBuilder()

public ReachabilityServiceSettings.Builder toBuilder()

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

Returns

Type	Description
`ReachabilityServiceSettings.Builder`

Overrides

ClientSettings<SettingsT>.<B>toBuilder()

updateConnectivityTestOperationSettings()

public OperationCallSettings<UpdateConnectivityTestRequest,ConnectivityTest,OperationMetadata> updateConnectivityTestOperationSettings()

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

Returns

Type	Description
`OperationCallSettings<UpdateConnectivityTestRequest,ConnectivityTest,OperationMetadata>`

updateConnectivityTestSettings()

public UnaryCallSettings<UpdateConnectivityTestRequest,Operation> updateConnectivityTestSettings()

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

Returns

Type	Description
`UnaryCallSettings<UpdateConnectivityTestRequest,Operation>`