public class ApiHubPluginSettings extends ClientSettings<ApiHubPluginSettings>Settings class to configure an instance of ApiHubPluginClient.
The default instance has everything set to sensible defaults:
- The default service address (apihub.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 getPlugin:
// 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
ApiHubPluginSettings.Builder apiHubPluginSettingsBuilder = ApiHubPluginSettings.newBuilder();
apiHubPluginSettingsBuilder
.getPluginSettings()
.setRetrySettings(
apiHubPluginSettingsBuilder
.getPluginSettings()
.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());
ApiHubPluginSettings apiHubPluginSettings = apiHubPluginSettingsBuilder.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 deletePlugin:
// 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
ApiHubPluginSettings.Builder apiHubPluginSettingsBuilder = ApiHubPluginSettings.newBuilder();
TimedRetryAlgorithm timedRetryAlgorithm =
OperationalTimedPollAlgorithm.create(
RetrySettings.newBuilder()
.setInitialRetryDelayDuration(Duration.ofMillis(500))
.setRetryDelayMultiplier(1.5)
.setMaxRetryDelayDuration(Duration.ofMillis(5000))
.setTotalTimeoutDuration(Duration.ofHours(24))
.build());
apiHubPluginSettingsBuilder
.createClusterOperationSettings()
.setPollingAlgorithm(timedRetryAlgorithm)
.build();
Static Methods
create(ApiHubPluginStubSettings stub)
public static final ApiHubPluginSettings create(ApiHubPluginStubSettings stub)| Parameter | |
|---|---|
| Name | Description |
stub |
ApiHubPluginStubSettings |
| Returns | |
|---|---|
| Type | Description |
ApiHubPluginSettings |
|
| 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 |
|
defaultHttpJsonTransportProviderBuilder()
public static InstantiatingHttpJsonChannelProvider.Builder defaultHttpJsonTransportProviderBuilder()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 ApiHubPluginSettings.Builder newBuilder()Returns a new builder for this class.
| Returns | |
|---|---|
| Type | Description |
ApiHubPluginSettings.Builder |
|
newBuilder(ClientContext clientContext)
public static ApiHubPluginSettings.Builder newBuilder(ClientContext clientContext)Returns a new builder for this class.
| Parameter | |
|---|---|
| Name | Description |
clientContext |
ClientContext |
| Returns | |
|---|---|
| Type | Description |
ApiHubPluginSettings.Builder |
|
Constructors
ApiHubPluginSettings(ApiHubPluginSettings.Builder settingsBuilder)
protected ApiHubPluginSettings(ApiHubPluginSettings.Builder settingsBuilder)| Parameter | |
|---|---|
| Name | Description |
settingsBuilder |
ApiHubPluginSettings.Builder |
Methods
createPluginInstanceOperationSettings()
public OperationCallSettings<CreatePluginInstanceRequest,PluginInstance,OperationMetadata> createPluginInstanceOperationSettings()Returns the object with the settings used for calls to createPluginInstance.
| Returns | |
|---|---|
| Type | Description |
OperationCallSettings<CreatePluginInstanceRequest,PluginInstance,OperationMetadata> |
|
createPluginInstanceSettings()
public UnaryCallSettings<CreatePluginInstanceRequest,Operation> createPluginInstanceSettings()Returns the object with the settings used for calls to createPluginInstance.
| Returns | |
|---|---|
| Type | Description |
UnaryCallSettings<CreatePluginInstanceRequest,Operation> |
|
createPluginSettings()
public UnaryCallSettings<CreatePluginRequest,Plugin> createPluginSettings()Returns the object with the settings used for calls to createPlugin.
| Returns | |
|---|---|
| Type | Description |
UnaryCallSettings<CreatePluginRequest,Plugin> |
|
deletePluginInstanceOperationSettings()
public OperationCallSettings<DeletePluginInstanceRequest,Empty,OperationMetadata> deletePluginInstanceOperationSettings()Returns the object with the settings used for calls to deletePluginInstance.
| Returns | |
|---|---|
| Type | Description |
OperationCallSettings<DeletePluginInstanceRequest,Empty,OperationMetadata> |
|
deletePluginInstanceSettings()
public UnaryCallSettings<DeletePluginInstanceRequest,Operation> deletePluginInstanceSettings()Returns the object with the settings used for calls to deletePluginInstance.
| Returns | |
|---|---|
| Type | Description |
UnaryCallSettings<DeletePluginInstanceRequest,Operation> |
|
deletePluginOperationSettings()
public OperationCallSettings<DeletePluginRequest,Empty,OperationMetadata> deletePluginOperationSettings()Returns the object with the settings used for calls to deletePlugin.
| Returns | |
|---|---|
| Type | Description |
OperationCallSettings<DeletePluginRequest,Empty,OperationMetadata> |
|
deletePluginSettings()
public UnaryCallSettings<DeletePluginRequest,Operation> deletePluginSettings()Returns the object with the settings used for calls to deletePlugin.
| Returns | |
|---|---|
| Type | Description |
UnaryCallSettings<DeletePluginRequest,Operation> |
|
disablePluginInstanceActionOperationSettings()
public OperationCallSettings<DisablePluginInstanceActionRequest,DisablePluginInstanceActionResponse,OperationMetadata> disablePluginInstanceActionOperationSettings()Returns the object with the settings used for calls to disablePluginInstanceAction.
| Returns | |
|---|---|
| Type | Description |
OperationCallSettings<DisablePluginInstanceActionRequest,DisablePluginInstanceActionResponse,OperationMetadata> |
|
disablePluginInstanceActionSettings()
public UnaryCallSettings<DisablePluginInstanceActionRequest,Operation> disablePluginInstanceActionSettings()Returns the object with the settings used for calls to disablePluginInstanceAction.
| Returns | |
|---|---|
| Type | Description |
UnaryCallSettings<DisablePluginInstanceActionRequest,Operation> |
|
disablePluginSettings()
public UnaryCallSettings<DisablePluginRequest,Plugin> disablePluginSettings()Returns the object with the settings used for calls to disablePlugin.
| Returns | |
|---|---|
| Type | Description |
UnaryCallSettings<DisablePluginRequest,Plugin> |
|
enablePluginInstanceActionOperationSettings()
public OperationCallSettings<EnablePluginInstanceActionRequest,EnablePluginInstanceActionResponse,OperationMetadata> enablePluginInstanceActionOperationSettings()Returns the object with the settings used for calls to enablePluginInstanceAction.
| Returns | |
|---|---|
| Type | Description |
OperationCallSettings<EnablePluginInstanceActionRequest,EnablePluginInstanceActionResponse,OperationMetadata> |
|
enablePluginInstanceActionSettings()
public UnaryCallSettings<EnablePluginInstanceActionRequest,Operation> enablePluginInstanceActionSettings()Returns the object with the settings used for calls to enablePluginInstanceAction.
| Returns | |
|---|---|
| Type | Description |
UnaryCallSettings<EnablePluginInstanceActionRequest,Operation> |
|
enablePluginSettings()
public UnaryCallSettings<EnablePluginRequest,Plugin> enablePluginSettings()Returns the object with the settings used for calls to enablePlugin.
| Returns | |
|---|---|
| Type | Description |
UnaryCallSettings<EnablePluginRequest,Plugin> |
|
executePluginInstanceActionOperationSettings()
public OperationCallSettings<ExecutePluginInstanceActionRequest,ExecutePluginInstanceActionResponse,OperationMetadata> executePluginInstanceActionOperationSettings()Returns the object with the settings used for calls to executePluginInstanceAction.
| Returns | |
|---|---|
| Type | Description |
OperationCallSettings<ExecutePluginInstanceActionRequest,ExecutePluginInstanceActionResponse,OperationMetadata> |
|
executePluginInstanceActionSettings()
public UnaryCallSettings<ExecutePluginInstanceActionRequest,Operation> executePluginInstanceActionSettings()Returns the object with the settings used for calls to executePluginInstanceAction.
| Returns | |
|---|---|
| Type | Description |
UnaryCallSettings<ExecutePluginInstanceActionRequest,Operation> |
|
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> |
|
getPluginInstanceSettings()
public UnaryCallSettings<GetPluginInstanceRequest,PluginInstance> getPluginInstanceSettings()Returns the object with the settings used for calls to getPluginInstance.
| Returns | |
|---|---|
| Type | Description |
UnaryCallSettings<GetPluginInstanceRequest,PluginInstance> |
|
getPluginSettings()
public UnaryCallSettings<GetPluginRequest,Plugin> getPluginSettings()Returns the object with the settings used for calls to getPlugin.
| Returns | |
|---|---|
| Type | Description |
UnaryCallSettings<GetPluginRequest,Plugin> |
|
listLocationsSettings()
public PagedCallSettings<ListLocationsRequest,ListLocationsResponse,ApiHubPluginClient.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> |
|
listPluginInstancesSettings()
public PagedCallSettings<ListPluginInstancesRequest,ListPluginInstancesResponse,ApiHubPluginClient.ListPluginInstancesPagedResponse> listPluginInstancesSettings()Returns the object with the settings used for calls to listPluginInstances.
| Returns | |
|---|---|
| Type | Description |
PagedCallSettings<ListPluginInstancesRequest,ListPluginInstancesResponse,ListPluginInstancesPagedResponse> |
|
listPluginsSettings()
public PagedCallSettings<ListPluginsRequest,ListPluginsResponse,ApiHubPluginClient.ListPluginsPagedResponse> listPluginsSettings()Returns the object with the settings used for calls to listPlugins.
| Returns | |
|---|---|
| Type | Description |
PagedCallSettings<ListPluginsRequest,ListPluginsResponse,ListPluginsPagedResponse> |
|
toBuilder()
public ApiHubPluginSettings.Builder toBuilder()Returns a builder containing all the values of this settings class.
| Returns | |
|---|---|
| Type | Description |
ApiHubPluginSettings.Builder |
|
updatePluginInstanceSettings()
public UnaryCallSettings<UpdatePluginInstanceRequest,PluginInstance> updatePluginInstanceSettings()Returns the object with the settings used for calls to updatePluginInstance.
| Returns | |
|---|---|
| Type | Description |
UnaryCallSettings<UpdatePluginInstanceRequest,PluginInstance> |
|