Class ManagedIdentitiesServiceStubSettings (1.52.0)

public class ManagedIdentitiesServiceStubSettings extends StubSettings<ManagedIdentitiesServiceStubSettings>

Settings class to configure an instance of ManagedIdentitiesServiceStub.

The default instance has everything set to sensible defaults:

The default service address (managedidentities.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 resetAdminPassword:


 // 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
 ManagedIdentitiesServiceStubSettings.Builder managedIdentitiesServiceSettingsBuilder =
     ManagedIdentitiesServiceStubSettings.newBuilder();
 managedIdentitiesServiceSettingsBuilder
     .resetAdminPasswordSettings()
     .setRetrySettings(
         managedIdentitiesServiceSettingsBuilder
             .resetAdminPasswordSettings()
             .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());
 ManagedIdentitiesServiceStubSettings managedIdentitiesServiceSettings =
     managedIdentitiesServiceSettingsBuilder.build();

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

To configure the RetrySettings of a Long Running Operation method, create an OperationTimedPollAlgorithm object and update the RPC's polling algorithm. For example, to configure the RetrySettings for createMicrosoftAdDomain:


 // 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
 ManagedIdentitiesServiceStubSettings.Builder managedIdentitiesServiceSettingsBuilder =
     ManagedIdentitiesServiceStubSettings.newBuilder();
 TimedRetryAlgorithm timedRetryAlgorithm =
     OperationalTimedPollAlgorithm.create(
         RetrySettings.newBuilder()
             .setInitialRetryDelayDuration(Duration.ofMillis(500))
             .setRetryDelayMultiplier(1.5)
             .setMaxRetryDelayDuration(Duration.ofMillis(5000))
             .setTotalTimeoutDuration(Duration.ofHours(24))
             .build());
 managedIdentitiesServiceSettingsBuilder
     .createClusterOperationSettings()
     .setPollingAlgorithm(timedRetryAlgorithm)
     .build();

Inheritance

java.lang.Object > StubSettings > ManagedIdentitiesServiceStubSettings

Inherited Members

StubSettings.getApiKey()

StubSettings.getBackgroundExecutorProvider()

StubSettings.getClock()

StubSettings.getCredentialsProvider()

StubSettings.getEndpoint()

StubSettings.getExecutorProvider()

StubSettings.getGdchApiAudience()

StubSettings.getHeaderProvider()

StubSettings.getInternalHeaderProvider()

StubSettings.getMtlsEndpoint()

StubSettings.getQuotaProjectId()

StubSettings.getServiceName()

StubSettings.getStreamWatchdogCheckInterval()

StubSettings.getStreamWatchdogCheckIntervalDuration()

StubSettings.getStreamWatchdogProvider()

StubSettings.getTracerFactory()

StubSettings.getTransportChannelProvider()

StubSettings.getUniverseDomain()

StubSettings.toBuilder()

StubSettings.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

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 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 ManagedIdentitiesServiceStubSettings.Builder newBuilder()

Returns a new builder for this class.

Returns
Type	Description
`ManagedIdentitiesServiceStubSettings.Builder`

newBuilder(ClientContext clientContext)

public static ManagedIdentitiesServiceStubSettings.Builder newBuilder(ClientContext clientContext)

Returns a new builder for this class.

Parameter
Name	Description
`clientContext`	`ClientContext`

Returns
Type	Description
`ManagedIdentitiesServiceStubSettings.Builder`

Constructors

ManagedIdentitiesServiceStubSettings(ManagedIdentitiesServiceStubSettings.Builder settingsBuilder)

protected ManagedIdentitiesServiceStubSettings(ManagedIdentitiesServiceStubSettings.Builder settingsBuilder)

Parameter
Name	Description
`settingsBuilder`	`ManagedIdentitiesServiceStubSettings.Builder`

Methods

attachTrustOperationSettings()

public OperationCallSettings<AttachTrustRequest,Domain,OpMetadata> attachTrustOperationSettings()

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

Returns
Type	Description
`OperationCallSettings<AttachTrustRequest,Domain,OpMetadata>`

attachTrustSettings()

public UnaryCallSettings<AttachTrustRequest,Operation> attachTrustSettings()

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

Returns
Type	Description
`UnaryCallSettings<AttachTrustRequest,Operation>`

createMicrosoftAdDomainOperationSettings()

public OperationCallSettings<CreateMicrosoftAdDomainRequest,Domain,OpMetadata> createMicrosoftAdDomainOperationSettings()

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

Returns
Type	Description
`OperationCallSettings<CreateMicrosoftAdDomainRequest,Domain,OpMetadata>`

createMicrosoftAdDomainSettings()

public UnaryCallSettings<CreateMicrosoftAdDomainRequest,Operation> createMicrosoftAdDomainSettings()

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

Returns
Type	Description
`UnaryCallSettings<CreateMicrosoftAdDomainRequest,Operation>`

createStub()

public ManagedIdentitiesServiceStub createStub()

Returns
Type	Description
`ManagedIdentitiesServiceStub`

Exceptions
Type	Description
`IOException`

deleteDomainOperationSettings()

public OperationCallSettings<DeleteDomainRequest,Empty,OpMetadata> deleteDomainOperationSettings()

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

Returns
Type	Description
`OperationCallSettings<DeleteDomainRequest,Empty,OpMetadata>`

deleteDomainSettings()

public UnaryCallSettings<DeleteDomainRequest,Operation> deleteDomainSettings()

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

Returns
Type	Description
`UnaryCallSettings<DeleteDomainRequest,Operation>`

detachTrustOperationSettings()

public OperationCallSettings<DetachTrustRequest,Domain,OpMetadata> detachTrustOperationSettings()

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

Returns
Type	Description
`OperationCallSettings<DetachTrustRequest,Domain,OpMetadata>`

detachTrustSettings()

public UnaryCallSettings<DetachTrustRequest,Operation> detachTrustSettings()

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

Returns
Type	Description
`UnaryCallSettings<DetachTrustRequest,Operation>`

getDomainSettings()

public UnaryCallSettings<GetDomainRequest,Domain> getDomainSettings()

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

Returns
Type	Description
`UnaryCallSettings<GetDomainRequest,Domain>`

getServiceName()

public String getServiceName()

Returns the default service name.

Returns
Type	Description
`String`

Overrides

StubSettings<SettingsT>.getServiceName()

listDomainsSettings()

public PagedCallSettings<ListDomainsRequest,ListDomainsResponse,ManagedIdentitiesServiceClient.ListDomainsPagedResponse> listDomainsSettings()

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

Returns
Type	Description
`PagedCallSettings<ListDomainsRequest,ListDomainsResponse,ListDomainsPagedResponse>`

reconfigureTrustOperationSettings()

public OperationCallSettings<ReconfigureTrustRequest,Domain,OpMetadata> reconfigureTrustOperationSettings()

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

Returns
Type	Description
`OperationCallSettings<ReconfigureTrustRequest,Domain,OpMetadata>`

reconfigureTrustSettings()

public UnaryCallSettings<ReconfigureTrustRequest,Operation> reconfigureTrustSettings()

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

Returns
Type	Description
`UnaryCallSettings<ReconfigureTrustRequest,Operation>`

resetAdminPasswordSettings()

public UnaryCallSettings<ResetAdminPasswordRequest,ResetAdminPasswordResponse> resetAdminPasswordSettings()

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

Returns
Type	Description
`UnaryCallSettings<ResetAdminPasswordRequest,ResetAdminPasswordResponse>`

toBuilder()

public ManagedIdentitiesServiceStubSettings.Builder toBuilder()

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

Returns
Type	Description
`ManagedIdentitiesServiceStubSettings.Builder`

Overrides

StubSettings<SettingsT>.toBuilder()

updateDomainOperationSettings()

public OperationCallSettings<UpdateDomainRequest,Domain,OpMetadata> updateDomainOperationSettings()

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

Returns
Type	Description
`OperationCallSettings<UpdateDomainRequest,Domain,OpMetadata>`

updateDomainSettings()

public UnaryCallSettings<UpdateDomainRequest,Operation> updateDomainSettings()

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

Returns
Type	Description
`UnaryCallSettings<UpdateDomainRequest,Operation>`

validateTrustOperationSettings()

public OperationCallSettings<ValidateTrustRequest,Domain,OpMetadata> validateTrustOperationSettings()

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

Returns
Type	Description
`OperationCallSettings<ValidateTrustRequest,Domain,OpMetadata>`

validateTrustSettings()

public UnaryCallSettings<ValidateTrustRequest,Operation> validateTrustSettings()

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

Returns
Type	Description
`UnaryCallSettings<ValidateTrustRequest,Operation>`