public class OsLoginServiceStubSettings extends StubSettings<OsLoginServiceStubSettings>Settings class to configure an instance of OsLoginServiceStub.
The default instance has everything set to sensible defaults:
- The default service address (oslogin.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 deletePosixAccount to 30 seconds:
// This snippet has been automatically generated for illustrative purposes only.
// It may require modifications to work in your environment.
OsLoginServiceStubSettings.Builder osLoginServiceSettingsBuilder =
OsLoginServiceStubSettings.newBuilder();
osLoginServiceSettingsBuilder
.deletePosixAccountSettings()
.setRetrySettings(
osLoginServiceSettingsBuilder
.deletePosixAccountSettings()
.getRetrySettings()
.toBuilder()
.setTotalTimeout(Duration.ofSeconds(30))
.build());
OsLoginServiceStubSettings osLoginServiceSettings = osLoginServiceSettingsBuilder.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 OsLoginServiceStubSettings.Builder newBuilder()Returns a new builder for this class.
| Type | Description |
| OsLoginServiceStubSettings.Builder |
newBuilder(ClientContext clientContext)
public static OsLoginServiceStubSettings.Builder newBuilder(ClientContext clientContext)Returns a new builder for this class.
| Name | Description |
| clientContext | ClientContext |
| Type | Description |
| OsLoginServiceStubSettings.Builder |
Constructors
OsLoginServiceStubSettings(OsLoginServiceStubSettings.Builder settingsBuilder)
protected OsLoginServiceStubSettings(OsLoginServiceStubSettings.Builder settingsBuilder)| Name | Description |
| settingsBuilder | OsLoginServiceStubSettings.Builder |
Methods
createStub()
public OsLoginServiceStub createStub()| Type | Description |
| OsLoginServiceStub |
| Type | Description |
| IOException |
deletePosixAccountSettings()
public UnaryCallSettings<DeletePosixAccountRequest,Empty> deletePosixAccountSettings()Returns the object with the settings used for calls to deletePosixAccount.
| Type | Description |
| UnaryCallSettings<DeletePosixAccountRequest,Empty> |
deleteSshPublicKeySettings()
public UnaryCallSettings<DeleteSshPublicKeyRequest,Empty> deleteSshPublicKeySettings()Returns the object with the settings used for calls to deleteSshPublicKey.
| Type | Description |
| UnaryCallSettings<DeleteSshPublicKeyRequest,Empty> |
getLoginProfileSettings()
public UnaryCallSettings<GetLoginProfileRequest,LoginProfile> getLoginProfileSettings()Returns the object with the settings used for calls to getLoginProfile.
| Type | Description |
| UnaryCallSettings<GetLoginProfileRequest,LoginProfile> |
getSshPublicKeySettings()
public UnaryCallSettings<GetSshPublicKeyRequest,OsLoginProto.SshPublicKey> getSshPublicKeySettings()Returns the object with the settings used for calls to getSshPublicKey.
| Type | Description |
| UnaryCallSettings<GetSshPublicKeyRequest,SshPublicKey> |
importSshPublicKeySettings()
public UnaryCallSettings<ImportSshPublicKeyRequest,ImportSshPublicKeyResponse> importSshPublicKeySettings()Returns the object with the settings used for calls to importSshPublicKey.
| Type | Description |
| UnaryCallSettings<ImportSshPublicKeyRequest,ImportSshPublicKeyResponse> |
toBuilder()
public OsLoginServiceStubSettings.Builder toBuilder()Returns a builder containing all the values of this settings class.
| Type | Description |
| OsLoginServiceStubSettings.Builder |
updateSshPublicKeySettings()
public UnaryCallSettings<UpdateSshPublicKeyRequest,OsLoginProto.SshPublicKey> updateSshPublicKeySettings()Returns the object with the settings used for calls to updateSshPublicKey.
| Type | Description |
| UnaryCallSettings<UpdateSshPublicKeyRequest,SshPublicKey> |