com.google.cloud.oslogin.v1.stub

Class OsLoginServiceStubSettings

java.lang.Object

com.google.api.gax.rpc.StubSettings<OsLoginServiceStubSettings>

com.google.cloud.oslogin.v1.stub.OsLoginServiceStubSettings

@Generated(value="by gapic-generator")
 @BetaApi
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:

 
 OsLoginServiceStubSettings.Builder osLoginServiceSettingsBuilder =
     OsLoginServiceStubSettings.newBuilder();
 osLoginServiceSettingsBuilder.deletePosixAccountSettings().getRetrySettings().toBuilder()
     .setTotalTimeout(Duration.ofSeconds(30));
 OsLoginServiceStubSettings osLoginServiceSettings = osLoginServiceSettingsBuilder.build();
 
 

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	OsLoginServiceStubSettings.Builder Builder for OsLoginServiceStubSettings.

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	OsLoginServiceStubSettings(OsLoginServiceStubSettings.Builder settingsBuilder)

Method Summary

Modifier and Type	Method and Description
OsLoginServiceStub	createStub()
static ApiClientHeaderProvider.Builder	defaultApiClientHeaderProviderBuilder()
static GoogleCredentialsProvider.Builder	defaultCredentialsProviderBuilder() Returns a builder for the default credentials for this service.
static InstantiatingExecutorProvider.Builder	defaultExecutorProviderBuilder() Returns a builder for the default ExecutorProvider for this service.
static InstantiatingGrpcChannelProvider.Builder	defaultGrpcTransportProviderBuilder() Returns a builder for the default ChannelProvider for this service.
static TransportChannelProvider	defaultTransportChannelProvider()
UnaryCallSettings<com.google.cloud.oslogin.v1.DeletePosixAccountRequest,Empty>	deletePosixAccountSettings() Returns the object with the settings used for calls to deletePosixAccount.
UnaryCallSettings<com.google.cloud.oslogin.v1.DeleteSshPublicKeyRequest,Empty>	deleteSshPublicKeySettings() Returns the object with the settings used for calls to deleteSshPublicKey.
static String	getDefaultEndpoint() Returns the default service endpoint.
static List<String>	getDefaultServiceScopes() Returns the default service scopes.
UnaryCallSettings<com.google.cloud.oslogin.v1.GetLoginProfileRequest,com.google.cloud.oslogin.v1.LoginProfile>	getLoginProfileSettings() Returns the object with the settings used for calls to getLoginProfile.
UnaryCallSettings<com.google.cloud.oslogin.v1.GetSshPublicKeyRequest,com.google.cloud.oslogin.common.OsLoginProto.SshPublicKey>	getSshPublicKeySettings() Returns the object with the settings used for calls to getSshPublicKey.
UnaryCallSettings<com.google.cloud.oslogin.v1.ImportSshPublicKeyRequest,com.google.cloud.oslogin.v1.ImportSshPublicKeyResponse>	importSshPublicKeySettings() Returns the object with the settings used for calls to importSshPublicKey.
static OsLoginServiceStubSettings.Builder	newBuilder() Returns a new builder for this class.
static OsLoginServiceStubSettings.Builder	newBuilder(ClientContext clientContext) Returns a new builder for this class.
OsLoginServiceStubSettings.Builder	toBuilder() Returns a builder containing all the values of this settings class.
UnaryCallSettings<com.google.cloud.oslogin.v1.UpdateSshPublicKeyRequest,com.google.cloud.oslogin.common.OsLoginProto.SshPublicKey>	updateSshPublicKeySettings() Returns the object with the settings used for calls to updateSshPublicKey.

Methods inherited from class com.google.api.gax.rpc.StubSettings

getClock, getCredentialsProvider, getEndpoint, getExecutorProvider, getHeaderProvider, getInternalHeaderProvider, getStreamWatchdogCheckInterval, getStreamWatchdogProvider, getTracerFactory, getTransportChannelProvider, toString

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

OsLoginServiceStubSettings

protected OsLoginServiceStubSettings(OsLoginServiceStubSettings.Builder settingsBuilder)
                              throws IOException

Throws:

IOException

Method Detail

deletePosixAccountSettings

public UnaryCallSettings<com.google.cloud.oslogin.v1.DeletePosixAccountRequest,Empty> deletePosixAccountSettings()

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

deleteSshPublicKeySettings

public UnaryCallSettings<com.google.cloud.oslogin.v1.DeleteSshPublicKeyRequest,Empty> deleteSshPublicKeySettings()

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

getLoginProfileSettings

public UnaryCallSettings<com.google.cloud.oslogin.v1.GetLoginProfileRequest,com.google.cloud.oslogin.v1.LoginProfile> getLoginProfileSettings()

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

getSshPublicKeySettings

public UnaryCallSettings<com.google.cloud.oslogin.v1.GetSshPublicKeyRequest,com.google.cloud.oslogin.common.OsLoginProto.SshPublicKey> getSshPublicKeySettings()

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

importSshPublicKeySettings

public UnaryCallSettings<com.google.cloud.oslogin.v1.ImportSshPublicKeyRequest,com.google.cloud.oslogin.v1.ImportSshPublicKeyResponse> importSshPublicKeySettings()

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

updateSshPublicKeySettings

public UnaryCallSettings<com.google.cloud.oslogin.v1.UpdateSshPublicKeyRequest,com.google.cloud.oslogin.common.OsLoginProto.SshPublicKey> updateSshPublicKeySettings()

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

createStub

@BetaApi(value="A restructuring of stub classes is planned, so this may break in the future")
public OsLoginServiceStub createStub()
                                                                                                                            throws IOException

Throws:

IOException

defaultExecutorProviderBuilder

public static InstantiatingExecutorProvider.Builder defaultExecutorProviderBuilder()

Returns a builder for the default ExecutorProvider for this service.

getDefaultEndpoint

public static String getDefaultEndpoint()

Returns the default service endpoint.

getDefaultServiceScopes

public static List<String> getDefaultServiceScopes()

Returns the default service scopes.

defaultCredentialsProviderBuilder

public static GoogleCredentialsProvider.Builder defaultCredentialsProviderBuilder()

Returns a builder for the default credentials for this service.

defaultGrpcTransportProviderBuilder

public static InstantiatingGrpcChannelProvider.Builder defaultGrpcTransportProviderBuilder()

Returns a builder for the default ChannelProvider for this service.

defaultTransportChannelProvider

public static TransportChannelProvider defaultTransportChannelProvider()

defaultApiClientHeaderProviderBuilder

@BetaApi(value="The surface for customizing headers is not stable yet and may change in the future.")
public static ApiClientHeaderProvider.Builder defaultApiClientHeaderProviderBuilder()

newBuilder

public static OsLoginServiceStubSettings.Builder newBuilder()

Returns a new builder for this class.

newBuilder

public static OsLoginServiceStubSettings.Builder newBuilder(ClientContext clientContext)

Returns a new builder for this class.

toBuilder

public OsLoginServiceStubSettings.Builder toBuilder()

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

Specified by:

toBuilder in class StubSettings<OsLoginServiceStubSettings>