Class ServiceHealthStubSettings
java.lang.Object
com.google.api.gax.rpc.StubSettings<ServiceHealthStubSettings>
com.google.cloud.servicehealth.v1.stub.ServiceHealthStubSettings
@Generated("by gapic-generator-java")
public class ServiceHealthStubSettings
extends StubSettings<ServiceHealthStubSettings>
Settings class to configure an instance of
ServiceHealthStub.
The default instance has everything set to sensible defaults:
- The default service address (servicehealth.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 getEvent:
// 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
ServiceHealthStubSettings.Builder serviceHealthSettingsBuilder =
ServiceHealthStubSettings.newBuilder();
serviceHealthSettingsBuilder
.getEventSettings()
.setRetrySettings(
serviceHealthSettingsBuilder
.getEventSettings()
.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());
ServiceHealthStubSettings serviceHealthSettings = serviceHealthSettingsBuilder.build();
Please refer to the [Client Side Retry
Guide](https://docs.cloud.google.com/java/docs/client-retries) for additional support in setting
retries.-
Nested Class Summary
Nested ClassesModifier and TypeClassDescriptionstatic classBuilder for ServiceHealthStubSettings. -
Constructor Summary
ConstructorsModifierConstructorDescriptionprotectedServiceHealthStubSettings(ServiceHealthStubSettings.Builder settingsBuilder) -
Method Summary
Modifier and TypeMethodDescriptionReturns 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 gRPC ChannelProvider for this service.Returns a builder for the default REST ChannelProvider for this service.static TransportChannelProviderstatic StringReturns the default service endpoint.static StringReturns the default mTLS service endpoint.Returns the default service scopes.Returns the object with the settings used for calls to getEvent.protected LibraryMetadataReturns the object with the settings used for calls to getLocation.Returns the object with the settings used for calls to getOrganizationEvent.Returns the object with the settings used for calls to getOrganizationImpact.Returns the default service name.Returns the object with the settings used for calls to listEvents.PagedCallSettings<ListLocationsRequest,ListLocationsResponse, ServiceHealthClient.ListLocationsPagedResponse> Returns the object with the settings used for calls to listLocations.PagedCallSettings<ListOrganizationEventsRequest,ListOrganizationEventsResponse, ServiceHealthClient.ListOrganizationEventsPagedResponse> Returns the object with the settings used for calls to listOrganizationEvents.PagedCallSettings<ListOrganizationImpactsRequest,ListOrganizationImpactsResponse, ServiceHealthClient.ListOrganizationImpactsPagedResponse> Returns the object with the settings used for calls to listOrganizationImpacts.Returns a new gRPC builder for this class.newBuilder(ClientContext clientContext) Returns a new builder for this class.Returns a new REST builder for this class.Returns a builder containing all the values of this settings class.Methods inherited from class com.google.api.gax.rpc.StubSettings
getApiKey, getBackgroundExecutorProvider, getClock, getCredentialsProvider, getEndpoint, getExecutorProvider, getGdchApiAudience, getHeaderProvider, getInternalHeaderProvider, getMtlsEndpoint, getQuotaProjectId, getStreamWatchdogCheckInterval, getStreamWatchdogCheckIntervalDuration, getStreamWatchdogProvider, getTracerFactory, getTransportChannelProvider, getUniverseDomain, toString
-
Constructor Details
-
ServiceHealthStubSettings
protected ServiceHealthStubSettings(ServiceHealthStubSettings.Builder settingsBuilder) throws IOException - Throws:
IOException
-
-
Method Details
-
listEventsSettings
public PagedCallSettings<ListEventsRequest,ListEventsResponse, listEventsSettings()ServiceHealthClient.ListEventsPagedResponse> Returns the object with the settings used for calls to listEvents. -
getEventSettings
Returns the object with the settings used for calls to getEvent. -
listOrganizationEventsSettings
public PagedCallSettings<ListOrganizationEventsRequest,ListOrganizationEventsResponse, listOrganizationEventsSettings()ServiceHealthClient.ListOrganizationEventsPagedResponse> Returns the object with the settings used for calls to listOrganizationEvents. -
getOrganizationEventSettings
public UnaryCallSettings<GetOrganizationEventRequest,OrganizationEvent> getOrganizationEventSettings()Returns the object with the settings used for calls to getOrganizationEvent. -
listOrganizationImpactsSettings
public PagedCallSettings<ListOrganizationImpactsRequest,ListOrganizationImpactsResponse, listOrganizationImpactsSettings()ServiceHealthClient.ListOrganizationImpactsPagedResponse> Returns the object with the settings used for calls to listOrganizationImpacts. -
getOrganizationImpactSettings
public UnaryCallSettings<GetOrganizationImpactRequest,OrganizationImpact> getOrganizationImpactSettings()Returns the object with the settings used for calls to getOrganizationImpact. -
listLocationsSettings
public PagedCallSettings<ListLocationsRequest,ListLocationsResponse, listLocationsSettings()ServiceHealthClient.ListLocationsPagedResponse> Returns the object with the settings used for calls to listLocations. -
getLocationSettings
Returns the object with the settings used for calls to getLocation. -
createStub
- Throws:
IOException
-
getServiceName
Returns the default service name.- Overrides:
getServiceNamein classStubSettings<ServiceHealthStubSettings>
-
defaultExecutorProviderBuilder
Returns a builder for the default ExecutorProvider for this service. -
getDefaultEndpoint
Returns the default service endpoint. -
getDefaultMtlsEndpoint
Returns the default mTLS 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 gRPC ChannelProvider for this service. -
defaultHttpJsonTransportProviderBuilder
@BetaApi public static InstantiatingHttpJsonChannelProvider.Builder defaultHttpJsonTransportProviderBuilder()Returns a builder for the default REST ChannelProvider for this service. -
defaultTransportChannelProvider
-
defaultGrpcApiClientHeaderProviderBuilder
-
defaultHttpJsonApiClientHeaderProviderBuilder
-
defaultApiClientHeaderProviderBuilder
-
newBuilder
Returns a new gRPC builder for this class. -
newHttpJsonBuilder
Returns a new REST 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 classStubSettings<ServiceHealthStubSettings>
-
getLibraryMetadata
- Overrides:
getLibraryMetadatain classStubSettings<ServiceHealthStubSettings>
-