Class TransportManagerSettings
java.lang.Object
com.google.api.gax.rpc.ClientSettings<TransportManagerSettings>
com.google.cloud.networkconnectivity.v1beta.TransportManagerSettings
@BetaApi
@Generated("by gapic-generator-java")
public class TransportManagerSettings
extends ClientSettings<TransportManagerSettings>
Settings class to configure an instance of
TransportManagerClient.
The default instance has everything set to sensible defaults:
- The default service address (networkconnectivity.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 getRemoteTransportProfile:
// 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
TransportManagerSettings.Builder transportManagerSettingsBuilder =
TransportManagerSettings.newBuilder();
transportManagerSettingsBuilder
.getRemoteTransportProfileSettings()
.setRetrySettings(
transportManagerSettingsBuilder
.getRemoteTransportProfileSettings()
.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());
TransportManagerSettings transportManagerSettings = transportManagerSettingsBuilder.build();
Please refer to the [Client Side Retry
Guide](https://docs.cloud.google.com/java/docs/client-retries) for additional support in setting
retries.
To configure the RetrySettings of a Long Running Operation method, create an OperationTimedPollAlgorithm object and update the RPC's polling algorithm. For example, to configure the RetrySettings for createTransport:
// 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
TransportManagerSettings.Builder transportManagerSettingsBuilder =
TransportManagerSettings.newBuilder();
TimedRetryAlgorithm timedRetryAlgorithm =
OperationalTimedPollAlgorithm.create(
RetrySettings.newBuilder()
.setInitialRetryDelayDuration(Duration.ofMillis(500))
.setRetryDelayMultiplier(1.5)
.setMaxRetryDelayDuration(Duration.ofMillis(5000))
.setTotalTimeoutDuration(Duration.ofHours(24))
.build());
transportManagerSettingsBuilder
.createClusterOperationSettings()
.setPollingAlgorithm(timedRetryAlgorithm)
.build();
-
Nested Class Summary
Nested ClassesModifier and TypeClassDescriptionstatic classBuilder for TransportManagerSettings. -
Constructor Summary
ConstructorsModifierConstructorDescriptionprotectedTransportManagerSettings(TransportManagerSettings.Builder settingsBuilder) -
Method Summary
Modifier and TypeMethodDescriptionstatic final TransportManagerSettingsReturns the object with the settings used for calls to createTransport.Returns the object with the settings used for calls to createTransport.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 ChannelProvider for this service.static TransportChannelProviderOperationCallSettings<DeleteTransportRequest,com.google.protobuf.Empty, OperationMetadata> Returns the object with the settings used for calls to deleteTransport.Returns the object with the settings used for calls to deleteTransport.static StringReturns the default service endpoint.Returns the default service scopes.Returns the object with the settings used for calls to getIamPolicy.Returns the object with the settings used for calls to getLocation.Returns the object with the settings used for calls to getRemoteTransportProfile.Returns the object with the settings used for calls to getStatus.Returns the object with the settings used for calls to getTransport.PagedCallSettings<ListLocationsRequest,ListLocationsResponse, TransportManagerClient.ListLocationsPagedResponse> Returns the object with the settings used for calls to listLocations.PagedCallSettings<ListRemoteTransportProfilesRequest,ListRemoteTransportProfilesResponse, TransportManagerClient.ListRemoteTransportProfilesPagedResponse> Returns the object with the settings used for calls to listRemoteTransportProfiles.PagedCallSettings<ListTransportsRequest,ListTransportsResponse, TransportManagerClient.ListTransportsPagedResponse> Returns the object with the settings used for calls to listTransports.Returns a new builder for this class.newBuilder(ClientContext clientContext) Returns a new builder for this class.Returns the object with the settings used for calls to setIamPolicy.Returns the object with the settings used for calls to testIamPermissions.Returns a builder containing all the values of this settings class.Returns the object with the settings used for calls to updateTransport.Returns the object with the settings used for calls to updateTransport.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
-
TransportManagerSettings
protected TransportManagerSettings(TransportManagerSettings.Builder settingsBuilder) throws IOException - Throws:
IOException
-
-
Method Details
-
listRemoteTransportProfilesSettings
public PagedCallSettings<ListRemoteTransportProfilesRequest,ListRemoteTransportProfilesResponse, listRemoteTransportProfilesSettings()TransportManagerClient.ListRemoteTransportProfilesPagedResponse> Returns the object with the settings used for calls to listRemoteTransportProfiles. -
getRemoteTransportProfileSettings
public UnaryCallSettings<GetRemoteTransportProfileRequest,RemoteTransportProfile> getRemoteTransportProfileSettings()Returns the object with the settings used for calls to getRemoteTransportProfile. -
listTransportsSettings
public PagedCallSettings<ListTransportsRequest,ListTransportsResponse, listTransportsSettings()TransportManagerClient.ListTransportsPagedResponse> Returns the object with the settings used for calls to listTransports. -
getTransportSettings
Returns the object with the settings used for calls to getTransport. -
getStatusSettings
Returns the object with the settings used for calls to getStatus. -
createTransportSettings
Returns the object with the settings used for calls to createTransport. -
createTransportOperationSettings
public OperationCallSettings<CreateTransportRequest,Transport, createTransportOperationSettings()OperationMetadata> Returns the object with the settings used for calls to createTransport. -
updateTransportSettings
Returns the object with the settings used for calls to updateTransport. -
updateTransportOperationSettings
public OperationCallSettings<UpdateTransportRequest,Transport, updateTransportOperationSettings()OperationMetadata> Returns the object with the settings used for calls to updateTransport. -
deleteTransportSettings
Returns the object with the settings used for calls to deleteTransport. -
deleteTransportOperationSettings
public OperationCallSettings<DeleteTransportRequest,com.google.protobuf.Empty, deleteTransportOperationSettings()OperationMetadata> Returns the object with the settings used for calls to deleteTransport. -
listLocationsSettings
public PagedCallSettings<ListLocationsRequest,ListLocationsResponse, listLocationsSettings()TransportManagerClient.ListLocationsPagedResponse> Returns the object with the settings used for calls to listLocations. -
getLocationSettings
Returns the object with the settings used for calls to getLocation. -
setIamPolicySettings
Returns the object with the settings used for calls to setIamPolicy. -
getIamPolicySettings
Returns the object with the settings used for calls to getIamPolicy. -
testIamPermissionsSettings
public UnaryCallSettings<TestIamPermissionsRequest,TestIamPermissionsResponse> testIamPermissionsSettings()Returns the object with the settings used for calls to testIamPermissions. -
create
public static final TransportManagerSettings create(TransportManagerStubSettings 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 ChannelProvider for this service. -
defaultTransportChannelProvider
-
defaultApiClientHeaderProviderBuilder
-
newBuilder
Returns a new 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<TransportManagerSettings>
-