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 total timeout of getEnvironment to 30 seconds:
CloudShellServiceStubSettings.Builder cloudShellServiceSettingsBuilder =
CloudShellServiceStubSettings.newBuilder();
cloudShellServiceSettingsBuilder
.getEnvironmentSettings()
.setRetrySettings(
cloudShellServiceSettingsBuilder
.getEnvironmentSettings()
.getRetrySettings()
.toBuilder()
.setTotalTimeout(Duration.ofSeconds(30))
.build());
CloudShellServiceStubSettings cloudShellServiceSettings =
cloudShellServiceSettingsBuilder.build();
Static Methods
defaultApiClientHeaderProviderBuilder()
public static ApiClientHeaderProvider.Builder defaultApiClientHeaderProviderBuilder()| Type | Description |
| Builder |
defaultCredentialsProviderBuilder()
public static GoogleCredentialsProvider.Builder defaultCredentialsProviderBuilder()Returns a builder for the default credentials for this service.
| Type | Description |
| Builder |
defaultExecutorProviderBuilder()
public static InstantiatingExecutorProvider.Builder defaultExecutorProviderBuilder()Returns a builder for the default ExecutorProvider for this service.
| Type | Description |
| Builder |
defaultGrpcTransportProviderBuilder()
public static InstantiatingGrpcChannelProvider.Builder defaultGrpcTransportProviderBuilder()Returns a builder for the default ChannelProvider for this service.
| Type | Description |
| Builder |
defaultTransportChannelProvider()
public static TransportChannelProvider defaultTransportChannelProvider()| Type | Description |
| TransportChannelProvider |
getDefaultEndpoint()
public static String getDefaultEndpoint()Returns the default service endpoint.
| Type | Description |
| String |
getDefaultMtlsEndpoint()
public static String getDefaultMtlsEndpoint()Returns the default mTLS service endpoint.
| Type | Description |
| String |
getDefaultServiceScopes()
public static List<String> getDefaultServiceScopes()Returns the default service scopes.
| Type | Description |
| List<String> |
newBuilder()
public static CloudShellServiceStubSettings.Builder newBuilder()Returns a new builder for this class.
| Type | Description |
| CloudShellServiceStubSettings.Builder |
newBuilder(ClientContext clientContext)
public static CloudShellServiceStubSettings.Builder newBuilder(ClientContext clientContext)Returns a new builder for this class.
| Name | Description |
| clientContext | ClientContext |
| Type | Description |
| CloudShellServiceStubSettings.Builder |
Constructors
CloudShellServiceStubSettings(CloudShellServiceStubSettings.Builder settingsBuilder)
protected CloudShellServiceStubSettings(CloudShellServiceStubSettings.Builder settingsBuilder)| Name | Description |
| settingsBuilder | CloudShellServiceStubSettings.Builder |
Methods
addPublicKeyOperationSettings()
public OperationCallSettings<AddPublicKeyRequest,AddPublicKeyResponse,AddPublicKeyMetadata> addPublicKeyOperationSettings()Returns the object with the settings used for calls to addPublicKey.
| Type | Description |
| OperationCallSettings<AddPublicKeyRequest,AddPublicKeyResponse,AddPublicKeyMetadata> |
addPublicKeySettings()
public UnaryCallSettings<AddPublicKeyRequest,Operation> addPublicKeySettings()Returns the object with the settings used for calls to addPublicKey.
| Type | Description |
| UnaryCallSettings<AddPublicKeyRequest,Operation> |
authorizeEnvironmentOperationSettings()
public OperationCallSettings<AuthorizeEnvironmentRequest,AuthorizeEnvironmentResponse,AuthorizeEnvironmentMetadata> authorizeEnvironmentOperationSettings()Returns the object with the settings used for calls to authorizeEnvironment.
| Type | Description |
| OperationCallSettings<AuthorizeEnvironmentRequest,AuthorizeEnvironmentResponse,AuthorizeEnvironmentMetadata> |
authorizeEnvironmentSettings()
public UnaryCallSettings<AuthorizeEnvironmentRequest,Operation> authorizeEnvironmentSettings()Returns the object with the settings used for calls to authorizeEnvironment.
| Type | Description |
| UnaryCallSettings<AuthorizeEnvironmentRequest,Operation> |
createStub()
public CloudShellServiceStub createStub()| Type | Description |
| CloudShellServiceStub |
| Type | Description |
| IOException |
getEnvironmentSettings()
public UnaryCallSettings<GetEnvironmentRequest,Environment> getEnvironmentSettings()Returns the object with the settings used for calls to getEnvironment.
| Type | Description |
| UnaryCallSettings<GetEnvironmentRequest,Environment> |
removePublicKeyOperationSettings()
public OperationCallSettings<RemovePublicKeyRequest,RemovePublicKeyResponse,RemovePublicKeyMetadata> removePublicKeyOperationSettings()Returns the object with the settings used for calls to removePublicKey.
| Type | Description |
| OperationCallSettings<RemovePublicKeyRequest,RemovePublicKeyResponse,RemovePublicKeyMetadata> |
removePublicKeySettings()
public UnaryCallSettings<RemovePublicKeyRequest,Operation> removePublicKeySettings()Returns the object with the settings used for calls to removePublicKey.
| Type | Description |
| UnaryCallSettings<RemovePublicKeyRequest,Operation> |
startEnvironmentOperationSettings()
public OperationCallSettings<StartEnvironmentRequest,StartEnvironmentResponse,StartEnvironmentMetadata> startEnvironmentOperationSettings()Returns the object with the settings used for calls to startEnvironment.
| Type | Description |
| OperationCallSettings<StartEnvironmentRequest,StartEnvironmentResponse,StartEnvironmentMetadata> |
startEnvironmentSettings()
public UnaryCallSettings<StartEnvironmentRequest,Operation> startEnvironmentSettings()Returns the object with the settings used for calls to startEnvironment.
| Type | Description |
| UnaryCallSettings<StartEnvironmentRequest,Operation> |
toBuilder()
public CloudShellServiceStubSettings.Builder toBuilder()Returns a builder containing all the values of this settings class.
| Type | Description |
| CloudShellServiceStubSettings.Builder |