Package com.google.cloud.shell.v1.stub
Class CloudShellServiceStubSettings
java.lang.Object
com.google.api.gax.rpc.StubSettings<CloudShellServiceStubSettings>
com.google.cloud.shell.v1.stub.CloudShellServiceStubSettings
@Generated("by gapic-generator-java")
public class CloudShellServiceStubSettings
extends StubSettings<CloudShellServiceStubSettings>
Settings class to configure an instance of
CloudShellServiceStub.
The default instance has everything set to sensible defaults:
- The default service address (cloudshell.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 getEnvironment:
// 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
CloudShellServiceStubSettings.Builder cloudShellServiceSettingsBuilder =
CloudShellServiceStubSettings.newBuilder();
cloudShellServiceSettingsBuilder
.getEnvironmentSettings()
.setRetrySettings(
cloudShellServiceSettingsBuilder
.getEnvironmentSettings()
.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());
CloudShellServiceStubSettings cloudShellServiceSettings =
cloudShellServiceSettingsBuilder.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 startEnvironment:
// 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
CloudShellServiceStubSettings.Builder cloudShellServiceSettingsBuilder =
CloudShellServiceStubSettings.newBuilder();
TimedRetryAlgorithm timedRetryAlgorithm =
OperationalTimedPollAlgorithm.create(
RetrySettings.newBuilder()
.setInitialRetryDelayDuration(Duration.ofMillis(500))
.setRetryDelayMultiplier(1.5)
.setMaxRetryDelayDuration(Duration.ofMillis(5000))
.setTotalTimeoutDuration(Duration.ofHours(24))
.build());
cloudShellServiceSettingsBuilder
.createClusterOperationSettings()
.setPollingAlgorithm(timedRetryAlgorithm)
.build();
-
Nested Class Summary
Nested ClassesModifier and TypeClassDescriptionstatic classBuilder for CloudShellServiceStubSettings. -
Constructor Summary
ConstructorsModifierConstructorDescriptionprotectedCloudShellServiceStubSettings(CloudShellServiceStubSettings.Builder settingsBuilder) -
Method Summary
Modifier and TypeMethodDescriptionReturns the object with the settings used for calls to addPublicKey.Returns the object with the settings used for calls to addPublicKey.OperationCallSettings<AuthorizeEnvironmentRequest,AuthorizeEnvironmentResponse, AuthorizeEnvironmentMetadata> Returns the object with the settings used for calls to authorizeEnvironment.Returns the object with the settings used for calls to authorizeEnvironment.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 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 getEnvironment.protected LibraryMetadataReturns the default service name.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 the object with the settings used for calls to removePublicKey.Returns the object with the settings used for calls to removePublicKey.Returns the object with the settings used for calls to startEnvironment.Returns the object with the settings used for calls to startEnvironment.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
-
CloudShellServiceStubSettings
protected CloudShellServiceStubSettings(CloudShellServiceStubSettings.Builder settingsBuilder) throws IOException - Throws:
IOException
-
-
Method Details
-
getEnvironmentSettings
Returns the object with the settings used for calls to getEnvironment. -
startEnvironmentSettings
Returns the object with the settings used for calls to startEnvironment. -
startEnvironmentOperationSettings
public OperationCallSettings<StartEnvironmentRequest,StartEnvironmentResponse, startEnvironmentOperationSettings()StartEnvironmentMetadata> Returns the object with the settings used for calls to startEnvironment. -
authorizeEnvironmentSettings
Returns the object with the settings used for calls to authorizeEnvironment. -
authorizeEnvironmentOperationSettings
public OperationCallSettings<AuthorizeEnvironmentRequest,AuthorizeEnvironmentResponse, authorizeEnvironmentOperationSettings()AuthorizeEnvironmentMetadata> Returns the object with the settings used for calls to authorizeEnvironment. -
addPublicKeySettings
Returns the object with the settings used for calls to addPublicKey. -
addPublicKeyOperationSettings
public OperationCallSettings<AddPublicKeyRequest,AddPublicKeyResponse, addPublicKeyOperationSettings()AddPublicKeyMetadata> Returns the object with the settings used for calls to addPublicKey. -
removePublicKeySettings
Returns the object with the settings used for calls to removePublicKey. -
removePublicKeyOperationSettings
public OperationCallSettings<RemovePublicKeyRequest,RemovePublicKeyResponse, removePublicKeyOperationSettings()RemovePublicKeyMetadata> Returns the object with the settings used for calls to removePublicKey. -
createStub
- Throws:
IOException
-
getServiceName
Returns the default service name.- Overrides:
getServiceNamein classStubSettings<CloudShellServiceStubSettings>
-
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<CloudShellServiceStubSettings>
-
getLibraryMetadata
- Overrides:
getLibraryMetadatain classStubSettings<CloudShellServiceStubSettings>
-