Class GkeHubStubSettings
java.lang.Object
com.google.api.gax.rpc.StubSettings<GkeHubStubSettings>
com.google.cloud.gkehub.v1beta.stub.GkeHubStubSettings
@BetaApi
@Generated("by gapic-generator-java")
public class GkeHubStubSettings
extends StubSettings<GkeHubStubSettings>
Settings class to configure an instance of
GkeHubStub.
The default instance has everything set to sensible defaults:
- The default service address (gkehub.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 getFeature:
// 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
GkeHubStubSettings.Builder gkeHubSettingsBuilder = GkeHubStubSettings.newBuilder();
gkeHubSettingsBuilder
.getFeatureSettings()
.setRetrySettings(
gkeHubSettingsBuilder
.getFeatureSettings()
.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());
GkeHubStubSettings gkeHubSettings = gkeHubSettingsBuilder.build();
Please refer to the [Client Side Retry
Guide](https://docs.cloud.google.com/java/docs/client-retries) 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 createFeature:
// 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
GkeHubStubSettings.Builder gkeHubSettingsBuilder = GkeHubStubSettings.newBuilder();
TimedRetryAlgorithm timedRetryAlgorithm =
OperationalTimedPollAlgorithm.create(
RetrySettings.newBuilder()
.setInitialRetryDelayDuration(Duration.ofMillis(500))
.setRetryDelayMultiplier(1.5)
.setMaxRetryDelayDuration(Duration.ofMillis(5000))
.setTotalTimeoutDuration(Duration.ofHours(24))
.build());
gkeHubSettingsBuilder
.createClusterOperationSettings()
.setPollingAlgorithm(timedRetryAlgorithm)
.build();
-
Nested Class Summary
Nested ClassesModifier and TypeClassDescriptionstatic classBuilder for GkeHubStubSettings. -
Constructor Summary
ConstructorsModifierConstructorDescriptionprotectedGkeHubStubSettings(GkeHubStubSettings.Builder settingsBuilder) -
Method Summary
Modifier and TypeMethodDescriptionReturns the object with the settings used for calls to createFeature.Returns the object with the settings used for calls to createFeature.Returns 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 TransportChannelProviderOperationCallSettings<DeleteFeatureRequest,com.google.protobuf.Empty, OperationMetadata> Returns the object with the settings used for calls to deleteFeature.Returns the object with the settings used for calls to deleteFeature.static 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 getFeature.protected LibraryMetadataReturns the default service name.Returns the object with the settings used for calls to listFeatures.static GkeHubStubSettings.BuilderReturns a new gRPC builder for this class.static GkeHubStubSettings.BuildernewBuilder(ClientContext clientContext) Returns a new builder for this class.static GkeHubStubSettings.BuilderReturns a new REST builder for this class.Returns a builder containing all the values of this settings class.Returns the object with the settings used for calls to updateFeature.Returns the object with the settings used for calls to updateFeature.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
-
GkeHubStubSettings
- Throws:
IOException
-
-
Method Details
-
listFeaturesSettings
public PagedCallSettings<ListFeaturesRequest,ListFeaturesResponse, listFeaturesSettings()GkeHubClient.ListFeaturesPagedResponse> Returns the object with the settings used for calls to listFeatures. -
getFeatureSettings
Returns the object with the settings used for calls to getFeature. -
createFeatureSettings
Returns the object with the settings used for calls to createFeature. -
createFeatureOperationSettings
public OperationCallSettings<CreateFeatureRequest,Feature, createFeatureOperationSettings()OperationMetadata> Returns the object with the settings used for calls to createFeature. -
deleteFeatureSettings
Returns the object with the settings used for calls to deleteFeature. -
deleteFeatureOperationSettings
public OperationCallSettings<DeleteFeatureRequest,com.google.protobuf.Empty, deleteFeatureOperationSettings()OperationMetadata> Returns the object with the settings used for calls to deleteFeature. -
updateFeatureSettings
Returns the object with the settings used for calls to updateFeature. -
updateFeatureOperationSettings
public OperationCallSettings<UpdateFeatureRequest,Feature, updateFeatureOperationSettings()OperationMetadata> Returns the object with the settings used for calls to updateFeature. -
createStub
- Throws:
IOException
-
getServiceName
Returns the default service name.- Overrides:
getServiceNamein classStubSettings<GkeHubStubSettings>
-
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<GkeHubStubSettings>
-
getLibraryMetadata
- Overrides:
getLibraryMetadatain classStubSettings<GkeHubStubSettings>
-