- 1.54.0 (latest)
- 1.53.0
- 1.52.0
- 1.51.0
- 1.50.0
- 1.48.0
- 1.47.0
- 1.46.0
- 1.45.0
- 1.44.0
- 1.43.0
- 1.42.0
- 1.41.0
- 1.40.0
- 1.39.0
- 1.38.0
- 1.36.0
- 1.35.0
- 1.34.0
- 1.33.0
- 1.32.0
- 1.31.0
- 1.30.0
- 1.29.0
- 1.28.0
- 1.27.0
- 1.26.0
- 1.23.0
- 1.22.0
- 1.21.0
- 1.20.0
- 1.19.0
- 1.18.0
- 1.17.0
- 1.16.0
- 1.15.0
- 1.14.0
- 1.13.0
- 1.12.0
- 1.11.0
- 1.10.0
- 1.8.0
- 1.7.0
- 1.6.0
- 1.5.0
- 1.4.0
- 1.3.0
- 1.2.9
- 1.1.1
- 1.0.0
- 0.5.0
public class HubServiceStubSettings extends StubSettings<HubServiceStubSettings>Settings class to configure an instance of HubServiceStub.
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 of getHub:
// 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
HubServiceStubSettings.Builder hubServiceSettingsBuilder = HubServiceStubSettings.newBuilder();
hubServiceSettingsBuilder
.getHubSettings()
.setRetrySettings(
hubServiceSettingsBuilder
.getHubSettings()
.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());
HubServiceStubSettings hubServiceSettings = hubServiceSettingsBuilder.build();
Please refer to the Client Side Retry Guide 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 createHub:
// 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
HubServiceStubSettings.Builder hubServiceSettingsBuilder = HubServiceStubSettings.newBuilder();
TimedRetryAlgorithm timedRetryAlgorithm =
OperationalTimedPollAlgorithm.create(
RetrySettings.newBuilder()
.setInitialRetryDelayDuration(Duration.ofMillis(500))
.setRetryDelayMultiplier(1.5)
.setMaxRetryDelayDuration(Duration.ofMillis(5000))
.setTotalTimeoutDuration(Duration.ofHours(24))
.build());
hubServiceSettingsBuilder
.createClusterOperationSettings()
.setPollingAlgorithm(timedRetryAlgorithm)
.build();
Static Methods
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 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 |
|
getDefaultMtlsEndpoint()
public static String getDefaultMtlsEndpoint()Returns the default mTLS 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 HubServiceStubSettings.Builder newBuilder()Returns a new builder for this class.
| Returns | |
|---|---|
| Type | Description |
HubServiceStubSettings.Builder |
|
newBuilder(ClientContext clientContext)
public static HubServiceStubSettings.Builder newBuilder(ClientContext clientContext)Returns a new builder for this class.
| Parameter | |
|---|---|
| Name | Description |
clientContext |
ClientContext |
| Returns | |
|---|---|
| Type | Description |
HubServiceStubSettings.Builder |
|
Constructors
HubServiceStubSettings(HubServiceStubSettings.Builder settingsBuilder)
protected HubServiceStubSettings(HubServiceStubSettings.Builder settingsBuilder)| Parameter | |
|---|---|
| Name | Description |
settingsBuilder |
HubServiceStubSettings.Builder |
Methods
createHubOperationSettings()
public OperationCallSettings<CreateHubRequest,Hub,OperationMetadata> createHubOperationSettings()Returns the object with the settings used for calls to createHub.
| Returns | |
|---|---|
| Type | Description |
OperationCallSettings<CreateHubRequest,Hub,OperationMetadata> |
|
createHubSettings()
public UnaryCallSettings<CreateHubRequest,Operation> createHubSettings()Returns the object with the settings used for calls to createHub.
| Returns | |
|---|---|
| Type | Description |
UnaryCallSettings<CreateHubRequest,Operation> |
|
createSpokeOperationSettings()
public OperationCallSettings<CreateSpokeRequest,Spoke,OperationMetadata> createSpokeOperationSettings()Returns the object with the settings used for calls to createSpoke.
| Returns | |
|---|---|
| Type | Description |
OperationCallSettings<CreateSpokeRequest,Spoke,OperationMetadata> |
|
createSpokeSettings()
public UnaryCallSettings<CreateSpokeRequest,Operation> createSpokeSettings()Returns the object with the settings used for calls to createSpoke.
| Returns | |
|---|---|
| Type | Description |
UnaryCallSettings<CreateSpokeRequest,Operation> |
|
createStub()
public HubServiceStub createStub()| Returns | |
|---|---|
| Type | Description |
HubServiceStub |
|
| Exceptions | |
|---|---|
| Type | Description |
IOException |
|
deleteHubOperationSettings()
public OperationCallSettings<DeleteHubRequest,Empty,OperationMetadata> deleteHubOperationSettings()Returns the object with the settings used for calls to deleteHub.
| Returns | |
|---|---|
| Type | Description |
OperationCallSettings<DeleteHubRequest,Empty,OperationMetadata> |
|
deleteHubSettings()
public UnaryCallSettings<DeleteHubRequest,Operation> deleteHubSettings()Returns the object with the settings used for calls to deleteHub.
| Returns | |
|---|---|
| Type | Description |
UnaryCallSettings<DeleteHubRequest,Operation> |
|
deleteSpokeOperationSettings()
public OperationCallSettings<DeleteSpokeRequest,Empty,OperationMetadata> deleteSpokeOperationSettings()Returns the object with the settings used for calls to deleteSpoke.
| Returns | |
|---|---|
| Type | Description |
OperationCallSettings<DeleteSpokeRequest,Empty,OperationMetadata> |
|
deleteSpokeSettings()
public UnaryCallSettings<DeleteSpokeRequest,Operation> deleteSpokeSettings()Returns the object with the settings used for calls to deleteSpoke.
| Returns | |
|---|---|
| Type | Description |
UnaryCallSettings<DeleteSpokeRequest,Operation> |
|
getHubSettings()
public UnaryCallSettings<GetHubRequest,Hub> getHubSettings()Returns the object with the settings used for calls to getHub.
| Returns | |
|---|---|
| Type | Description |
UnaryCallSettings<GetHubRequest,Hub> |
|
getServiceName()
public String getServiceName()Returns the default service name.
| Returns | |
|---|---|
| Type | Description |
String |
|
getSpokeSettings()
public UnaryCallSettings<GetSpokeRequest,Spoke> getSpokeSettings()Returns the object with the settings used for calls to getSpoke.
| Returns | |
|---|---|
| Type | Description |
UnaryCallSettings<GetSpokeRequest,Spoke> |
|
listHubsSettings()
public PagedCallSettings<ListHubsRequest,ListHubsResponse,HubServiceClient.ListHubsPagedResponse> listHubsSettings()Returns the object with the settings used for calls to listHubs.
| Returns | |
|---|---|
| Type | Description |
PagedCallSettings<ListHubsRequest,ListHubsResponse,ListHubsPagedResponse> |
|
listSpokesSettings()
public PagedCallSettings<ListSpokesRequest,ListSpokesResponse,HubServiceClient.ListSpokesPagedResponse> listSpokesSettings()Returns the object with the settings used for calls to listSpokes.
| Returns | |
|---|---|
| Type | Description |
PagedCallSettings<ListSpokesRequest,ListSpokesResponse,ListSpokesPagedResponse> |
|
toBuilder()
public HubServiceStubSettings.Builder toBuilder()Returns a builder containing all the values of this settings class.
| Returns | |
|---|---|
| Type | Description |
HubServiceStubSettings.Builder |
|
updateHubOperationSettings()
public OperationCallSettings<UpdateHubRequest,Hub,OperationMetadata> updateHubOperationSettings()Returns the object with the settings used for calls to updateHub.
| Returns | |
|---|---|
| Type | Description |
OperationCallSettings<UpdateHubRequest,Hub,OperationMetadata> |
|
updateHubSettings()
public UnaryCallSettings<UpdateHubRequest,Operation> updateHubSettings()Returns the object with the settings used for calls to updateHub.
| Returns | |
|---|---|
| Type | Description |
UnaryCallSettings<UpdateHubRequest,Operation> |
|
updateSpokeOperationSettings()
public OperationCallSettings<UpdateSpokeRequest,Spoke,OperationMetadata> updateSpokeOperationSettings()Returns the object with the settings used for calls to updateSpoke.
| Returns | |
|---|---|
| Type | Description |
OperationCallSettings<UpdateSpokeRequest,Spoke,OperationMetadata> |
|
updateSpokeSettings()
public UnaryCallSettings<UpdateSpokeRequest,Operation> updateSpokeSettings()Returns the object with the settings used for calls to updateSpoke.
| Returns | |
|---|---|
| Type | Description |
UnaryCallSettings<UpdateSpokeRequest,Operation> |
|