- 1.52.0 (latest)
- 1.51.0
- 1.50.0
- 1.49.0
- 1.47.0
- 1.46.0
- 1.45.0
- 1.44.0
- 1.43.0
- 1.42.0
- 1.41.0
- 1.40.0
- 1.39.0
- 1.38.0
- 1.37.0
- 1.35.0
- 1.34.0
- 1.33.0
- 1.32.0
- 1.31.0
- 1.30.0
- 1.29.0
- 1.28.0
- 1.27.0
- 1.26.0
- 1.25.0
- 1.22.0
- 1.21.0
- 1.20.0
- 1.19.0
- 1.18.0
- 1.17.0
- 1.16.0
- 1.15.0
- 1.14.0
- 1.13.0
- 1.12.0
- 1.11.0
- 1.10.0
- 1.9.0
- 1.7.0
- 1.6.0
- 1.5.0
- 1.4.0
- 1.3.0
- 1.2.0
- 1.1.6
- 1.0.5
- 0.3.7
public class ManagedIdentitiesServiceSettings extends ClientSettings<ManagedIdentitiesServiceSettings>
Settings class to configure an instance of ManagedIdentitiesServiceClient.
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
ManagedIdentitiesServiceSettings.Builder managedIdentitiesServiceSettingsBuilder =
ManagedIdentitiesServiceSettings.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());
ManagedIdentitiesServiceSettings 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
ManagedIdentitiesServiceSettings.Builder managedIdentitiesServiceSettingsBuilder =
ManagedIdentitiesServiceSettings.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();
Static Methods
create(ManagedIdentitiesServiceStubSettings stub)
public static final ManagedIdentitiesServiceSettings create(ManagedIdentitiesServiceStubSettings stub)
Parameter | |
---|---|
Name | Description |
stub |
ManagedIdentitiesServiceStubSettings |
Returns | |
---|---|
Type | Description |
ManagedIdentitiesServiceSettings |
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 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 ManagedIdentitiesServiceSettings.Builder newBuilder()
Returns a new builder for this class.
Returns | |
---|---|
Type | Description |
ManagedIdentitiesServiceSettings.Builder |
newBuilder(ClientContext clientContext)
public static ManagedIdentitiesServiceSettings.Builder newBuilder(ClientContext clientContext)
Returns a new builder for this class.
Parameter | |
---|---|
Name | Description |
clientContext |
ClientContext |
Returns | |
---|---|
Type | Description |
ManagedIdentitiesServiceSettings.Builder |
Constructors
ManagedIdentitiesServiceSettings(ManagedIdentitiesServiceSettings.Builder settingsBuilder)
protected ManagedIdentitiesServiceSettings(ManagedIdentitiesServiceSettings.Builder settingsBuilder)
Parameter | |
---|---|
Name | Description |
settingsBuilder |
ManagedIdentitiesServiceSettings.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> |
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> |
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 ManagedIdentitiesServiceSettings.Builder toBuilder()
Returns a builder containing all the values of this settings class.
Returns | |
---|---|
Type | Description |
ManagedIdentitiesServiceSettings.Builder |
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> |