Class OsLoginServiceStubSettings (2.51.0) 

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 RetrySettings of createSshPublicKey:


 // 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
 OsLoginServiceStubSettings.Builder osLoginServiceSettingsBuilder =
     OsLoginServiceStubSettings.newBuilder();
 osLoginServiceSettingsBuilder
     .createSshPublicKeySettings()
     .setRetrySettings(
         osLoginServiceSettingsBuilder
             .createSshPublicKeySettings()
             .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());
 OsLoginServiceStubSettings osLoginServiceSettings = osLoginServiceSettingsBuilder.build();

Please refer to the Client Side Retry Guide for additional support in setting retries.

Inheritance

java.lang.Object > StubSettings > OsLoginServiceStubSettings

Static Methods

defaultApiClientHeaderProviderBuilder()

public static ApiClientHeaderProvider.Builder defaultApiClientHeaderProviderBuilder()
Returns
Type Description
Builder

defaultCredentialsProviderBuilder()

public static GoogleCredentialsProvider.Builder defaultCredentialsProviderBuilder()

Returns a builder for the default credentials for this service.

Returns
Type Description
Builder

defaultExecutorProviderBuilder()

public static InstantiatingExecutorProvider.Builder defaultExecutorProviderBuilder()

Returns a builder for the default ExecutorProvider for this service.

Returns
Type Description
Builder

defaultGrpcApiClientHeaderProviderBuilder()

public static ApiClientHeaderProvider.Builder defaultGrpcApiClientHeaderProviderBuilder()
Returns
Type Description
Builder

defaultGrpcTransportProviderBuilder()

public static InstantiatingGrpcChannelProvider.Builder defaultGrpcTransportProviderBuilder()

Returns a builder for the default gRPC ChannelProvider for this service.

Returns
Type Description
Builder

defaultHttpJsonApiClientHeaderProviderBuilder()

public static ApiClientHeaderProvider.Builder defaultHttpJsonApiClientHeaderProviderBuilder()
Returns
Type Description
Builder

defaultHttpJsonTransportProviderBuilder()

public static InstantiatingHttpJsonChannelProvider.Builder defaultHttpJsonTransportProviderBuilder()

Returns a builder for the default REST ChannelProvider for this service.

Returns
Type Description
Builder

defaultTransportChannelProvider()

public static TransportChannelProvider defaultTransportChannelProvider()
Returns
Type Description
TransportChannelProvider

getDefaultEndpoint()

public static String getDefaultEndpoint()

Returns the default service endpoint.

Returns
Type Description
String

getDefaultMtlsEndpoint()

public static String getDefaultMtlsEndpoint()

Returns the default mTLS service endpoint.

Returns
Type Description
String

getDefaultServiceScopes()

public static List<String> getDefaultServiceScopes()

Returns the default service scopes.

Returns
Type Description
List<String>

newBuilder()

public static OsLoginServiceStubSettings.Builder newBuilder()

Returns a new gRPC builder for this class.

Returns
Type Description
OsLoginServiceStubSettings.Builder

newBuilder(ClientContext clientContext)

public static OsLoginServiceStubSettings.Builder newBuilder(ClientContext clientContext)

Returns a new builder for this class.

Parameter
Name Description
clientContext ClientContext
Returns
Type Description
OsLoginServiceStubSettings.Builder

newHttpJsonBuilder()

public static OsLoginServiceStubSettings.Builder newHttpJsonBuilder()

Returns a new REST builder for this class.

Returns
Type Description
OsLoginServiceStubSettings.Builder

Constructors

OsLoginServiceStubSettings(OsLoginServiceStubSettings.Builder settingsBuilder)

protected OsLoginServiceStubSettings(OsLoginServiceStubSettings.Builder settingsBuilder)
Parameter
Name Description
settingsBuilder OsLoginServiceStubSettings.Builder

Methods

createSshPublicKeySettings()

public UnaryCallSettings<CreateSshPublicKeyRequest,OsLoginProto.SshPublicKey> createSshPublicKeySettings()

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

Returns
Type Description
UnaryCallSettings<CreateSshPublicKeyRequest,SshPublicKey>

createStub()

public OsLoginServiceStub createStub()
Returns
Type Description
OsLoginServiceStub
Exceptions
Type Description
IOException

deletePosixAccountSettings()

public UnaryCallSettings<DeletePosixAccountRequest,Empty> deletePosixAccountSettings()

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

Returns
Type Description
UnaryCallSettings<DeletePosixAccountRequest,Empty>

deleteSshPublicKeySettings()

public UnaryCallSettings<DeleteSshPublicKeyRequest,Empty> deleteSshPublicKeySettings()

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

Returns
Type Description
UnaryCallSettings<DeleteSshPublicKeyRequest,Empty>

getLoginProfileSettings()

public UnaryCallSettings<GetLoginProfileRequest,LoginProfile> getLoginProfileSettings()

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

Returns
Type Description
UnaryCallSettings<GetLoginProfileRequest,LoginProfile>

getServiceName()

public String getServiceName()

Returns the default service name.

Returns
Type Description
String
Overrides

getSshPublicKeySettings()

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

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

Returns
Type Description
UnaryCallSettings<GetSshPublicKeyRequest,SshPublicKey>

importSshPublicKeySettings()

public UnaryCallSettings<ImportSshPublicKeyRequest,ImportSshPublicKeyResponse> importSshPublicKeySettings()

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

Returns
Type Description
UnaryCallSettings<ImportSshPublicKeyRequest,ImportSshPublicKeyResponse>

toBuilder()

public OsLoginServiceStubSettings.Builder toBuilder()

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

Returns
Type Description
OsLoginServiceStubSettings.Builder
Overrides

updateSshPublicKeySettings()

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

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

Returns
Type Description
UnaryCallSettings<UpdateSshPublicKeyRequest,SshPublicKey>