Class OsLoginServiceSettings (2.11.0)

Version 2.11.0

• 2.52.0 (latest)
• 2.51.0
• 2.50.0
• 2.48.0
• 2.47.0
• 2.46.0
• 2.45.0
• 2.44.0
• 2.43.0
• 2.42.0
• 2.41.0
• 2.40.0
• 2.39.0
• 2.38.0
• 2.36.0
• 2.35.0
• 2.34.0
• 2.33.0
• 2.32.0
• 2.31.0
• 2.30.0
• 2.29.0
• 2.28.0
• 2.27.0
• 2.26.0
• 2.23.0
• 2.22.0
• 2.21.0
• 2.20.0
• 2.19.0
• 2.18.0
• 2.17.0
• 2.16.0
• 2.15.0
• 2.14.0
• 2.13.0
• 2.12.0
• 2.11.0
• 2.10.0
• 2.8.0
• 2.7.0
• 2.6.0
• 2.5.0
• 2.4.0
• 2.3.0
• 2.2.7
• 2.0.15

public class OsLoginServiceSettings extends ClientSettings<OsLoginServiceSettings>

Settings class to configure an instance of OsLoginServiceClient.

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 createSshPublicKey to 30 seconds:

 // 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
 OsLoginServiceSettings.Builder osLoginServiceSettingsBuilder =
     OsLoginServiceSettings.newBuilder();
 osLoginServiceSettingsBuilder
     .createSshPublicKeySettings()
     .setRetrySettings(
         osLoginServiceSettingsBuilder
             .createSshPublicKeySettings()
             .getRetrySettings()
             .toBuilder()
             .setTotalTimeout(Duration.ofSeconds(30))
             .build());
 OsLoginServiceSettings osLoginServiceSettings = osLoginServiceSettingsBuilder.build();
 

Inheritance

java.lang.Object > ClientSettings > OsLoginServiceSettings

Inherited Members

ClientSettings.<B>toBuilder()

ClientSettings.getBackgroundExecutorProvider()

ClientSettings.getClock()

ClientSettings.getCredentialsProvider()

ClientSettings.getEndpoint()

ClientSettings.getExecutorProvider()

ClientSettings.getHeaderProvider()

ClientSettings.getInternalHeaderProvider()

ClientSettings.getQuotaProjectId()

ClientSettings.getStubSettings()

ClientSettings.getTransportChannelProvider()

ClientSettings.getWatchdogCheckInterval()

ClientSettings.getWatchdogProvider()

ClientSettings.toString()

Object.clone()

Object.equals(Object)

Object.finalize()

Object.getClass()

Object.hashCode()

Object.notify()

Object.notifyAll()

Object.wait()

Object.wait(long)

Object.wait(long,int)

Static Methods

create(OsLoginServiceStubSettings stub)

public static final OsLoginServiceSettings create(OsLoginServiceStubSettings stub)

Parameter

Name	Description
stub	OsLoginServiceStubSettings

Returns

Type	Description
OsLoginServiceSettings

Exceptions

Type	Description
IOException

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

defaultGrpcTransportProviderBuilder()

public static InstantiatingGrpcChannelProvider.Builder defaultGrpcTransportProviderBuilder()

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

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

getDefaultServiceScopes()

public static List<String> getDefaultServiceScopes()

Returns the default service scopes.

Returns

Type	Description
List<String>

newBuilder()

public static OsLoginServiceSettings.Builder newBuilder()

Returns a new gRPC builder for this class.

Returns

Type	Description
OsLoginServiceSettings.Builder

newBuilder(ClientContext clientContext)

public static OsLoginServiceSettings.Builder newBuilder(ClientContext clientContext)

Returns a new builder for this class.

Parameter

Name	Description
clientContext	ClientContext

Returns

Type	Description
OsLoginServiceSettings.Builder

newHttpJsonBuilder()

public static OsLoginServiceSettings.Builder newHttpJsonBuilder()

Returns a new REST builder for this class.

Returns

Type	Description
OsLoginServiceSettings.Builder

Constructors

OsLoginServiceSettings(OsLoginServiceSettings.Builder settingsBuilder)

protected OsLoginServiceSettings(OsLoginServiceSettings.Builder settingsBuilder)

Parameter

Name	Description
settingsBuilder	OsLoginServiceSettings.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>

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>

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 OsLoginServiceSettings.Builder toBuilder()

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

Returns

Type	Description
OsLoginServiceSettings.Builder

Overrides

ClientSettings<SettingsT>.<B>toBuilder()

updateSshPublicKeySettings()

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

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

Returns

Type	Description
UnaryCallSettings<UpdateSshPublicKeyRequest,SshPublicKey>