Class OsLoginServiceStubSettings (2.0.15) 

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();

Inheritance

java.lang.Object > StubSettings > OsLoginServiceStubSettings

Static Methods

defaultApiClientHeaderProviderBuilder()

public static ApiClientHeaderProvider.Builder defaultApiClientHeaderProviderBuilder()
Returns
TypeDescription
Builder

defaultCredentialsProviderBuilder()

public static GoogleCredentialsProvider.Builder defaultCredentialsProviderBuilder()

Returns a builder for the default credentials for this service.

Returns
TypeDescription
Builder

defaultExecutorProviderBuilder()

public static InstantiatingExecutorProvider.Builder defaultExecutorProviderBuilder()

Returns a builder for the default ExecutorProvider for this service.

Returns
TypeDescription
Builder

defaultGrpcTransportProviderBuilder()

public static InstantiatingGrpcChannelProvider.Builder defaultGrpcTransportProviderBuilder()

Returns a builder for the default ChannelProvider for this service.

Returns
TypeDescription
Builder

defaultTransportChannelProvider()

public static TransportChannelProvider defaultTransportChannelProvider()
Returns
TypeDescription
TransportChannelProvider

getDefaultEndpoint()

public static String getDefaultEndpoint()

Returns the default service endpoint.

Returns
TypeDescription
String

getDefaultMtlsEndpoint()

public static String getDefaultMtlsEndpoint()

Returns the default mTLS service endpoint.

Returns
TypeDescription
String

getDefaultServiceScopes()

public static List<String> getDefaultServiceScopes()

Returns the default service scopes.

Returns
TypeDescription
List<String>

newBuilder()

public static OsLoginServiceStubSettings.Builder newBuilder()

Returns a new builder for this class.

Returns
TypeDescription
OsLoginServiceStubSettings.Builder

newBuilder(ClientContext clientContext)

public static OsLoginServiceStubSettings.Builder newBuilder(ClientContext clientContext)

Returns a new builder for this class.

Parameter
NameDescription
clientContextClientContext
Returns
TypeDescription
OsLoginServiceStubSettings.Builder

Constructors

OsLoginServiceStubSettings(OsLoginServiceStubSettings.Builder settingsBuilder)

protected OsLoginServiceStubSettings(OsLoginServiceStubSettings.Builder settingsBuilder)
Parameter
NameDescription
settingsBuilderOsLoginServiceStubSettings.Builder

Methods

createStub()

public OsLoginServiceStub createStub()
Returns
TypeDescription
OsLoginServiceStub
Exceptions
TypeDescription
IOException

deletePosixAccountSettings()

public UnaryCallSettings<DeletePosixAccountRequest,Empty> deletePosixAccountSettings()

Returns the object with the settings used for calls to deletePosixAccount.

Returns
TypeDescription
UnaryCallSettings<DeletePosixAccountRequest,Empty>

deleteSshPublicKeySettings()

public UnaryCallSettings<DeleteSshPublicKeyRequest,Empty> deleteSshPublicKeySettings()

Returns the object with the settings used for calls to deleteSshPublicKey.

Returns
TypeDescription
UnaryCallSettings<DeleteSshPublicKeyRequest,Empty>

getLoginProfileSettings()

public UnaryCallSettings<GetLoginProfileRequest,LoginProfile> getLoginProfileSettings()

Returns the object with the settings used for calls to getLoginProfile.

Returns
TypeDescription
UnaryCallSettings<GetLoginProfileRequest,LoginProfile>

getSshPublicKeySettings()

public UnaryCallSettings<GetSshPublicKeyRequest,OsLoginProto.SshPublicKey> getSshPublicKeySettings()

Returns the object with the settings used for calls to getSshPublicKey.

Returns
TypeDescription
UnaryCallSettings<GetSshPublicKeyRequest,SshPublicKey>

importSshPublicKeySettings()

public UnaryCallSettings<ImportSshPublicKeyRequest,ImportSshPublicKeyResponse> importSshPublicKeySettings()

Returns the object with the settings used for calls to importSshPublicKey.

Returns
TypeDescription
UnaryCallSettings<ImportSshPublicKeyRequest,ImportSshPublicKeyResponse>

toBuilder()

public OsLoginServiceStubSettings.Builder toBuilder()

Returns a builder containing all the values of this settings class.

Returns
TypeDescription
OsLoginServiceStubSettings.Builder
Overrides

updateSshPublicKeySettings()

public UnaryCallSettings<UpdateSshPublicKeyRequest,OsLoginProto.SshPublicKey> updateSshPublicKeySettings()

Returns the object with the settings used for calls to updateSshPublicKey.

Returns
TypeDescription
UnaryCallSettings<UpdateSshPublicKeyRequest,SshPublicKey>