Class ReachabilityServiceSettings
- java.lang.Object
-
- com.google.api.gax.rpc.ClientSettings<ReachabilityServiceSettings>
-
- com.google.cloud.networkmanagement.v1beta1.ReachabilityServiceSettings
-
@BetaApi @Generated("by gapic-generator-java") public class ReachabilityServiceSettings extends com.google.api.gax.rpc.ClientSettings<ReachabilityServiceSettings>
Settings class to configure an instance ofReachabilityServiceClient
.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();
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static class
ReachabilityServiceSettings.Builder
Builder for ReachabilityServiceSettings.
-
Constructor Summary
Constructors Modifier Constructor Description protected
ReachabilityServiceSettings(ReachabilityServiceSettings.Builder settingsBuilder)
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description static ReachabilityServiceSettings
create(ReachabilityServiceStubSettings stub)
com.google.api.gax.rpc.OperationCallSettings<CreateConnectivityTestRequest,ConnectivityTest,OperationMetadata>
createConnectivityTestOperationSettings()
Returns the object with the settings used for calls to createConnectivityTest.com.google.api.gax.rpc.UnaryCallSettings<CreateConnectivityTestRequest,com.google.longrunning.Operation>
createConnectivityTestSettings()
Returns the object with the settings used for calls to createConnectivityTest.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<DeleteConnectivityTestRequest,com.google.protobuf.Empty,OperationMetadata>
deleteConnectivityTestOperationSettings()
Returns the object with the settings used for calls to deleteConnectivityTest.com.google.api.gax.rpc.UnaryCallSettings<DeleteConnectivityTestRequest,com.google.longrunning.Operation>
deleteConnectivityTestSettings()
Returns the object with the settings used for calls to deleteConnectivityTest.com.google.api.gax.rpc.UnaryCallSettings<GetConnectivityTestRequest,ConnectivityTest>
getConnectivityTestSettings()
Returns the object with the settings used for calls to getConnectivityTest.static String
getDefaultEndpoint()
Returns the default service endpoint.static List<String>
getDefaultServiceScopes()
Returns the default service scopes.com.google.api.gax.rpc.PagedCallSettings<ListConnectivityTestsRequest,ListConnectivityTestsResponse,ReachabilityServiceClient.ListConnectivityTestsPagedResponse>
listConnectivityTestsSettings()
Returns the object with the settings used for calls to listConnectivityTests.static ReachabilityServiceSettings.Builder
newBuilder()
Returns a new gRPC builder for this class.static ReachabilityServiceSettings.Builder
newBuilder(com.google.api.gax.rpc.ClientContext clientContext)
Returns a new builder for this class.static ReachabilityServiceSettings.Builder
newHttpJsonBuilder()
Returns a new REST builder for this class.com.google.api.gax.rpc.OperationCallSettings<RerunConnectivityTestRequest,ConnectivityTest,OperationMetadata>
rerunConnectivityTestOperationSettings()
Returns the object with the settings used for calls to rerunConnectivityTest.com.google.api.gax.rpc.UnaryCallSettings<RerunConnectivityTestRequest,com.google.longrunning.Operation>
rerunConnectivityTestSettings()
Returns the object with the settings used for calls to rerunConnectivityTest.ReachabilityServiceSettings.Builder
toBuilder()
Returns a builder containing all the values of this settings class.com.google.api.gax.rpc.OperationCallSettings<UpdateConnectivityTestRequest,ConnectivityTest,OperationMetadata>
updateConnectivityTestOperationSettings()
Returns the object with the settings used for calls to updateConnectivityTest.com.google.api.gax.rpc.UnaryCallSettings<UpdateConnectivityTestRequest,com.google.longrunning.Operation>
updateConnectivityTestSettings()
Returns the object with the settings used for calls to updateConnectivityTest.-
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
-
ReachabilityServiceSettings
protected ReachabilityServiceSettings(ReachabilityServiceSettings.Builder settingsBuilder) throws IOException
- Throws:
IOException
-
-
Method Detail
-
listConnectivityTestsSettings
public com.google.api.gax.rpc.PagedCallSettings<ListConnectivityTestsRequest,ListConnectivityTestsResponse,ReachabilityServiceClient.ListConnectivityTestsPagedResponse> listConnectivityTestsSettings()
Returns the object with the settings used for calls to listConnectivityTests.
-
getConnectivityTestSettings
public com.google.api.gax.rpc.UnaryCallSettings<GetConnectivityTestRequest,ConnectivityTest> getConnectivityTestSettings()
Returns the object with the settings used for calls to getConnectivityTest.
-
createConnectivityTestSettings
public com.google.api.gax.rpc.UnaryCallSettings<CreateConnectivityTestRequest,com.google.longrunning.Operation> createConnectivityTestSettings()
Returns the object with the settings used for calls to createConnectivityTest.
-
createConnectivityTestOperationSettings
public com.google.api.gax.rpc.OperationCallSettings<CreateConnectivityTestRequest,ConnectivityTest,OperationMetadata> createConnectivityTestOperationSettings()
Returns the object with the settings used for calls to createConnectivityTest.
-
updateConnectivityTestSettings
public com.google.api.gax.rpc.UnaryCallSettings<UpdateConnectivityTestRequest,com.google.longrunning.Operation> updateConnectivityTestSettings()
Returns the object with the settings used for calls to updateConnectivityTest.
-
updateConnectivityTestOperationSettings
public com.google.api.gax.rpc.OperationCallSettings<UpdateConnectivityTestRequest,ConnectivityTest,OperationMetadata> updateConnectivityTestOperationSettings()
Returns the object with the settings used for calls to updateConnectivityTest.
-
rerunConnectivityTestSettings
public com.google.api.gax.rpc.UnaryCallSettings<RerunConnectivityTestRequest,com.google.longrunning.Operation> rerunConnectivityTestSettings()
Returns the object with the settings used for calls to rerunConnectivityTest.
-
rerunConnectivityTestOperationSettings
public com.google.api.gax.rpc.OperationCallSettings<RerunConnectivityTestRequest,ConnectivityTest,OperationMetadata> rerunConnectivityTestOperationSettings()
Returns the object with the settings used for calls to rerunConnectivityTest.
-
deleteConnectivityTestSettings
public com.google.api.gax.rpc.UnaryCallSettings<DeleteConnectivityTestRequest,com.google.longrunning.Operation> deleteConnectivityTestSettings()
Returns the object with the settings used for calls to deleteConnectivityTest.
-
deleteConnectivityTestOperationSettings
public com.google.api.gax.rpc.OperationCallSettings<DeleteConnectivityTestRequest,com.google.protobuf.Empty,OperationMetadata> deleteConnectivityTestOperationSettings()
Returns the object with the settings used for calls to deleteConnectivityTest.
-
create
public static final ReachabilityServiceSettings create(ReachabilityServiceStubSettings 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("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 ReachabilityServiceSettings.Builder newBuilder()
Returns a new gRPC builder for this class.
-
newHttpJsonBuilder
@BetaApi public static ReachabilityServiceSettings.Builder newHttpJsonBuilder()
Returns a new REST builder for this class.
-
newBuilder
public static ReachabilityServiceSettings.Builder newBuilder(com.google.api.gax.rpc.ClientContext clientContext)
Returns a new builder for this class.
-
toBuilder
public ReachabilityServiceSettings.Builder toBuilder()
Returns a builder containing all the values of this settings class.- Specified by:
toBuilder
in classcom.google.api.gax.rpc.ClientSettings<ReachabilityServiceSettings>
-
-