- 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 HubServiceSettings extends ClientSettings<HubServiceSettings>
Settings class to configure an instance of HubServiceClient.
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
HubServiceSettings.Builder hubServiceSettingsBuilder = HubServiceSettings.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());
HubServiceSettings 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
HubServiceSettings.Builder hubServiceSettingsBuilder = HubServiceSettings.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
create(HubServiceStubSettings stub)
public static final HubServiceSettings create(HubServiceStubSettings stub)
Parameter | |
---|---|
Name | Description |
stub |
HubServiceStubSettings |
Returns | |
---|---|
Type | Description |
HubServiceSettings |
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 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 HubServiceSettings.Builder newBuilder()
Returns a new builder for this class.
Returns | |
---|---|
Type | Description |
HubServiceSettings.Builder |
newBuilder(ClientContext clientContext)
public static HubServiceSettings.Builder newBuilder(ClientContext clientContext)
Returns a new builder for this class.
Parameter | |
---|---|
Name | Description |
clientContext |
ClientContext |
Returns | |
---|---|
Type | Description |
HubServiceSettings.Builder |
Constructors
HubServiceSettings(HubServiceSettings.Builder settingsBuilder)
protected HubServiceSettings(HubServiceSettings.Builder settingsBuilder)
Parameter | |
---|---|
Name | Description |
settingsBuilder |
HubServiceSettings.Builder |
Methods
acceptHubSpokeOperationSettings()
public OperationCallSettings<AcceptHubSpokeRequest,AcceptHubSpokeResponse,OperationMetadata> acceptHubSpokeOperationSettings()
Returns the object with the settings used for calls to acceptHubSpoke.
Returns | |
---|---|
Type | Description |
OperationCallSettings<AcceptHubSpokeRequest,AcceptHubSpokeResponse,OperationMetadata> |
acceptHubSpokeSettings()
public UnaryCallSettings<AcceptHubSpokeRequest,Operation> acceptHubSpokeSettings()
Returns the object with the settings used for calls to acceptHubSpoke.
Returns | |
---|---|
Type | Description |
UnaryCallSettings<AcceptHubSpokeRequest,Operation> |
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> |
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> |
getGroupSettings()
public UnaryCallSettings<GetGroupRequest,Group> getGroupSettings()
Returns the object with the settings used for calls to getGroup.
Returns | |
---|---|
Type | Description |
UnaryCallSettings<GetGroupRequest,Group> |
getHubSettings()
public UnaryCallSettings<GetHubRequest,Hub> getHubSettings()
Returns the object with the settings used for calls to getHub.
Returns | |
---|---|
Type | Description |
UnaryCallSettings<GetHubRequest,Hub> |
getIamPolicySettings()
public UnaryCallSettings<GetIamPolicyRequest,Policy> getIamPolicySettings()
Returns the object with the settings used for calls to getIamPolicy.
Returns | |
---|---|
Type | Description |
UnaryCallSettings<com.google.iam.v1.GetIamPolicyRequest,com.google.iam.v1.Policy> |
getLocationSettings()
public UnaryCallSettings<GetLocationRequest,Location> getLocationSettings()
Returns the object with the settings used for calls to getLocation.
Returns | |
---|---|
Type | Description |
UnaryCallSettings<com.google.cloud.location.GetLocationRequest,com.google.cloud.location.Location> |
getRouteSettings()
public UnaryCallSettings<GetRouteRequest,Route> getRouteSettings()
Returns the object with the settings used for calls to getRoute.
Returns | |
---|---|
Type | Description |
UnaryCallSettings<GetRouteRequest,Route> |
getRouteTableSettings()
public UnaryCallSettings<GetRouteTableRequest,RouteTable> getRouteTableSettings()
Returns the object with the settings used for calls to getRouteTable.
Returns | |
---|---|
Type | Description |
UnaryCallSettings<GetRouteTableRequest,RouteTable> |
getSpokeSettings()
public UnaryCallSettings<GetSpokeRequest,Spoke> getSpokeSettings()
Returns the object with the settings used for calls to getSpoke.
Returns | |
---|---|
Type | Description |
UnaryCallSettings<GetSpokeRequest,Spoke> |
listGroupsSettings()
public PagedCallSettings<ListGroupsRequest,ListGroupsResponse,HubServiceClient.ListGroupsPagedResponse> listGroupsSettings()
Returns the object with the settings used for calls to listGroups.
Returns | |
---|---|
Type | Description |
PagedCallSettings<ListGroupsRequest,ListGroupsResponse,ListGroupsPagedResponse> |
listHubSpokesSettings()
public PagedCallSettings<ListHubSpokesRequest,ListHubSpokesResponse,HubServiceClient.ListHubSpokesPagedResponse> listHubSpokesSettings()
Returns the object with the settings used for calls to listHubSpokes.
Returns | |
---|---|
Type | Description |
PagedCallSettings<ListHubSpokesRequest,ListHubSpokesResponse,ListHubSpokesPagedResponse> |
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> |
listLocationsSettings()
public PagedCallSettings<ListLocationsRequest,ListLocationsResponse,HubServiceClient.ListLocationsPagedResponse> listLocationsSettings()
Returns the object with the settings used for calls to listLocations.
Returns | |
---|---|
Type | Description |
PagedCallSettings<com.google.cloud.location.ListLocationsRequest,com.google.cloud.location.ListLocationsResponse,ListLocationsPagedResponse> |
listRouteTablesSettings()
public PagedCallSettings<ListRouteTablesRequest,ListRouteTablesResponse,HubServiceClient.ListRouteTablesPagedResponse> listRouteTablesSettings()
Returns the object with the settings used for calls to listRouteTables.
Returns | |
---|---|
Type | Description |
PagedCallSettings<ListRouteTablesRequest,ListRouteTablesResponse,ListRouteTablesPagedResponse> |
listRoutesSettings()
public PagedCallSettings<ListRoutesRequest,ListRoutesResponse,HubServiceClient.ListRoutesPagedResponse> listRoutesSettings()
Returns the object with the settings used for calls to listRoutes.
Returns | |
---|---|
Type | Description |
PagedCallSettings<ListRoutesRequest,ListRoutesResponse,ListRoutesPagedResponse> |
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> |
queryHubStatusSettings()
public PagedCallSettings<QueryHubStatusRequest,QueryHubStatusResponse,HubServiceClient.QueryHubStatusPagedResponse> queryHubStatusSettings()
Returns the object with the settings used for calls to queryHubStatus.
Returns | |
---|---|
Type | Description |
PagedCallSettings<QueryHubStatusRequest,QueryHubStatusResponse,QueryHubStatusPagedResponse> |
rejectHubSpokeOperationSettings()
public OperationCallSettings<RejectHubSpokeRequest,RejectHubSpokeResponse,OperationMetadata> rejectHubSpokeOperationSettings()
Returns the object with the settings used for calls to rejectHubSpoke.
Returns | |
---|---|
Type | Description |
OperationCallSettings<RejectHubSpokeRequest,RejectHubSpokeResponse,OperationMetadata> |
rejectHubSpokeSettings()
public UnaryCallSettings<RejectHubSpokeRequest,Operation> rejectHubSpokeSettings()
Returns the object with the settings used for calls to rejectHubSpoke.
Returns | |
---|---|
Type | Description |
UnaryCallSettings<RejectHubSpokeRequest,Operation> |
setIamPolicySettings()
public UnaryCallSettings<SetIamPolicyRequest,Policy> setIamPolicySettings()
Returns the object with the settings used for calls to setIamPolicy.
Returns | |
---|---|
Type | Description |
UnaryCallSettings<com.google.iam.v1.SetIamPolicyRequest,com.google.iam.v1.Policy> |
testIamPermissionsSettings()
public UnaryCallSettings<TestIamPermissionsRequest,TestIamPermissionsResponse> testIamPermissionsSettings()
Returns the object with the settings used for calls to testIamPermissions.
Returns | |
---|---|
Type | Description |
UnaryCallSettings<com.google.iam.v1.TestIamPermissionsRequest,com.google.iam.v1.TestIamPermissionsResponse> |
toBuilder()
public HubServiceSettings.Builder toBuilder()
Returns a builder containing all the values of this settings class.
Returns | |
---|---|
Type | Description |
HubServiceSettings.Builder |
updateGroupOperationSettings()
public OperationCallSettings<UpdateGroupRequest,Group,OperationMetadata> updateGroupOperationSettings()
Returns the object with the settings used for calls to updateGroup.
Returns | |
---|---|
Type | Description |
OperationCallSettings<UpdateGroupRequest,Group,OperationMetadata> |
updateGroupSettings()
public UnaryCallSettings<UpdateGroupRequest,Operation> updateGroupSettings()
Returns the object with the settings used for calls to updateGroup.
Returns | |
---|---|
Type | Description |
UnaryCallSettings<UpdateGroupRequest,Operation> |
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> |