Class ApiHubPluginStubSettings (0.8.0) 

public class ApiHubPluginStubSettings extends StubSettings<ApiHubPluginStubSettings>

Settings class to configure an instance of ApiHubPluginStub.

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
 ApiHubPluginStubSettings.Builder apiHubPluginSettingsBuilder =
     ApiHubPluginStubSettings.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());
 ApiHubPluginStubSettings apiHubPluginSettings = apiHubPluginSettingsBuilder.build();

Please refer to the Client Side Retry Guide for additional support in setting retries.

Inheritance

java.lang.Object > StubSettings > ApiHubPluginStubSettings

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

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

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 ApiHubPluginStubSettings.Builder newBuilder()

Returns a new builder for this class.

Returns
Type Description
ApiHubPluginStubSettings.Builder

newBuilder(ClientContext clientContext)

public static ApiHubPluginStubSettings.Builder newBuilder(ClientContext clientContext)

Returns a new builder for this class.

Parameter
Name Description
clientContext ClientContext
Returns
Type Description
ApiHubPluginStubSettings.Builder

Constructors

ApiHubPluginStubSettings(ApiHubPluginStubSettings.Builder settingsBuilder)

protected ApiHubPluginStubSettings(ApiHubPluginStubSettings.Builder settingsBuilder)
Parameter
Name Description
settingsBuilder ApiHubPluginStubSettings.Builder

Methods

createStub()

public ApiHubPluginStub createStub()
Returns
Type Description
ApiHubPluginStub
Exceptions
Type Description
IOException

disablePluginSettings()

public UnaryCallSettings<DisablePluginRequest,Plugin> disablePluginSettings()

Returns the object with the settings used for calls to disablePlugin.

Returns
Type Description
UnaryCallSettings<DisablePluginRequest,Plugin>

enablePluginSettings()

public UnaryCallSettings<EnablePluginRequest,Plugin> enablePluginSettings()

Returns the object with the settings used for calls to enablePlugin.

Returns
Type Description
UnaryCallSettings<EnablePluginRequest,Plugin>

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>

getPluginSettings()

public UnaryCallSettings<GetPluginRequest,Plugin> getPluginSettings()

Returns the object with the settings used for calls to getPlugin.

Returns
Type Description
UnaryCallSettings<GetPluginRequest,Plugin>

getServiceName()

public String getServiceName()

Returns the default service name.

Returns
Type Description
String
Overrides

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>

toBuilder()

public ApiHubPluginStubSettings.Builder toBuilder()

Returns a builder containing all the values of this settings class.

Returns
Type Description
ApiHubPluginStubSettings.Builder
Overrides