Class AuthProviderServiceSettings (0.1.0)

Beta

This library is covered by the Pre-GA Offerings Terms of the Terms of Service. Pre-GA libraries might have limited support, and changes to pre-GA libraries might not be compatible with other pre-GA versions. For more information, see the launch stage descriptions.

public class AuthProviderServiceSettings extends ClientSettings<AuthProviderServiceSettings>

Settings class to configure an instance of AuthProviderServiceClient.

The default instance has everything set to sensible defaults:

• The default service address (agentidentity.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 getAuthProvider:

 // 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
 AuthProviderServiceSettings.Builder authProviderServiceSettingsBuilder =
     AuthProviderServiceSettings.newBuilder();
 authProviderServiceSettingsBuilder
     .getAuthProviderSettings()
     .setRetrySettings(
         authProviderServiceSettingsBuilder
             .getAuthProviderSettings()
             .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());
 AuthProviderServiceSettings authProviderServiceSettings =
     authProviderServiceSettingsBuilder.build();
 

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

Inheritance

java.lang.Object > ClientSettings > AuthProviderServiceSettings

Inherited Members

ClientSettings.<B>toBuilder()

ClientSettings.getApiKey()

ClientSettings.getBackgroundExecutorProvider()

ClientSettings.getClock()

ClientSettings.getCredentialsProvider()

ClientSettings.getEndpoint()

ClientSettings.getExecutorProvider()

ClientSettings.getGdchApiAudience()

ClientSettings.getHeaderProvider()

ClientSettings.getInternalHeaderProvider()

ClientSettings.getQuotaProjectId()

ClientSettings.getStubSettings()

ClientSettings.getTransportChannelProvider()

ClientSettings.getUniverseDomain()

ClientSettings.getWatchdogCheckInterval()

ClientSettings.getWatchdogCheckIntervalDuration()

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(AuthProviderServiceStubSettings stub)

public static final AuthProviderServiceSettings create(AuthProviderServiceStubSettings stub)

Parameter
Name	Description
stub	AuthProviderServiceStubSettings

Returns
Type	Description
AuthProviderServiceSettings

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()

Beta

This feature is covered by the Pre-GA Offerings Terms of the Terms of Service. Pre-GA libraries might have limited support, and changes to pre-GA libraries might not be compatible with other pre-GA versions. For more information, see the launch stage descriptions.

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

Returns a new gRPC builder for this class.

Returns
Type	Description
AuthProviderServiceSettings.Builder

newBuilder(@Nullable ClientContext clientContext)

public static AuthProviderServiceSettings.Builder newBuilder(@Nullable ClientContext clientContext)

Returns a new builder for this class.

Parameter
Name	Description
clientContext	@org.jspecify.annotations.Nullable com.google.api.gax.rpc.ClientContext

Returns
Type	Description
AuthProviderServiceSettings.Builder

newHttpJsonBuilder()

public static AuthProviderServiceSettings.Builder newHttpJsonBuilder()

Returns a new REST builder for this class.

Returns
Type	Description
AuthProviderServiceSettings.Builder

Constructors

AuthProviderServiceSettings(AuthProviderServiceSettings.Builder settingsBuilder)

protected AuthProviderServiceSettings(AuthProviderServiceSettings.Builder settingsBuilder)

Parameter
Name	Description
settingsBuilder	AuthProviderServiceSettings.Builder

Methods

createAuthProviderSettings()

public UnaryCallSettings<CreateAuthProviderRequest,AuthProvider> createAuthProviderSettings()

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

Returns
Type	Description
UnaryCallSettings<CreateAuthProviderRequest,AuthProvider>

deleteAuthProviderSettings()

public UnaryCallSettings<DeleteAuthProviderRequest,Empty> deleteAuthProviderSettings()

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

Returns
Type	Description
UnaryCallSettings<DeleteAuthProviderRequest,Empty>

deleteAuthorizationSettings()

public UnaryCallSettings<DeleteAuthorizationRequest,Empty> deleteAuthorizationSettings()

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

Returns
Type	Description
UnaryCallSettings<DeleteAuthorizationRequest,Empty>

disableAuthProviderSettings()

public UnaryCallSettings<DisableAuthProviderRequest,AuthProvider> disableAuthProviderSettings()

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

Returns
Type	Description
UnaryCallSettings<DisableAuthProviderRequest,AuthProvider>

enableAuthProviderSettings()

public UnaryCallSettings<EnableAuthProviderRequest,AuthProvider> enableAuthProviderSettings()

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

Returns
Type	Description
UnaryCallSettings<EnableAuthProviderRequest,AuthProvider>

getAccessSummarySettings()

public UnaryCallSettings<GetAccessSummaryRequest,AccessSummary> getAccessSummarySettings()

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

Returns
Type	Description
UnaryCallSettings<GetAccessSummaryRequest,AccessSummary>

getAuthProviderSettings()

public UnaryCallSettings<GetAuthProviderRequest,AuthProvider> getAuthProviderSettings()

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

Returns
Type	Description
UnaryCallSettings<GetAuthProviderRequest,AuthProvider>

getAuthorizationSettings()

public UnaryCallSettings<GetAuthorizationRequest,Authorization> getAuthorizationSettings()

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

Returns
Type	Description
UnaryCallSettings<GetAuthorizationRequest,Authorization>

getIamPolicySettings()

public UnaryCallSettings<GetIamPolicyRequest,Policy> getIamPolicySettings()

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

Returns
Type	Description
UnaryCallSettings<com.google.iam.v1.GetIamPolicyRequest,com.google.iam.v1.Policy>

getLocationSettings()

public UnaryCallSettings<GetLocationRequest,Location> getLocationSettings()

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

Returns
Type	Description
UnaryCallSettings<com.google.cloud.location.GetLocationRequest,com.google.cloud.location.Location>

listAccessSummariesSettings()

public PagedCallSettings<ListAccessSummariesRequest,ListAccessSummariesResponse,AuthProviderServiceClient.ListAccessSummariesPagedResponse> listAccessSummariesSettings()

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

Returns
Type	Description
PagedCallSettings<ListAccessSummariesRequest,ListAccessSummariesResponse,ListAccessSummariesPagedResponse>

listAuthProvidersSettings()

public PagedCallSettings<ListAuthProvidersRequest,ListAuthProvidersResponse,AuthProviderServiceClient.ListAuthProvidersPagedResponse> listAuthProvidersSettings()

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

Returns
Type	Description
PagedCallSettings<ListAuthProvidersRequest,ListAuthProvidersResponse,ListAuthProvidersPagedResponse>

listAuthorizationsSettings()

public PagedCallSettings<ListAuthorizationsRequest,ListAuthorizationsResponse,AuthProviderServiceClient.ListAuthorizationsPagedResponse> listAuthorizationsSettings()

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

Returns
Type	Description
PagedCallSettings<ListAuthorizationsRequest,ListAuthorizationsResponse,ListAuthorizationsPagedResponse>

listLocationsSettings()

public PagedCallSettings<ListLocationsRequest,ListLocationsResponse,AuthProviderServiceClient.ListLocationsPagedResponse> listLocationsSettings()

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

Returns
Type	Description
PagedCallSettings<com.google.cloud.location.ListLocationsRequest,com.google.cloud.location.ListLocationsResponse,ListLocationsPagedResponse>

queryAuthProvidersSettings()

public PagedCallSettings<QueryAuthProvidersRequest,QueryAuthProvidersResponse,AuthProviderServiceClient.QueryAuthProvidersPagedResponse> queryAuthProvidersSettings()

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

Returns
Type	Description
PagedCallSettings<QueryAuthProvidersRequest,QueryAuthProvidersResponse,QueryAuthProvidersPagedResponse>

queryWorkloadsSettings()

public PagedCallSettings<QueryWorkloadsRequest,QueryWorkloadsResponse,AuthProviderServiceClient.QueryWorkloadsPagedResponse> queryWorkloadsSettings()

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

Returns
Type	Description
PagedCallSettings<QueryWorkloadsRequest,QueryWorkloadsResponse,QueryWorkloadsPagedResponse>

revokeAuthorizationSettings()

public UnaryCallSettings<RevokeAuthorizationRequest,RevokeAuthorizationResponse> revokeAuthorizationSettings()

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

Returns
Type	Description
UnaryCallSettings<RevokeAuthorizationRequest,RevokeAuthorizationResponse>

setIamPolicySettings()

public UnaryCallSettings<SetIamPolicyRequest,Policy> setIamPolicySettings()

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

Returns
Type	Description
UnaryCallSettings<com.google.iam.v1.SetIamPolicyRequest,com.google.iam.v1.Policy>

testIamPermissionsSettings()

public UnaryCallSettings<TestIamPermissionsRequest,TestIamPermissionsResponse> testIamPermissionsSettings()

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

Returns
Type	Description
UnaryCallSettings<com.google.iam.v1.TestIamPermissionsRequest,com.google.iam.v1.TestIamPermissionsResponse>

toBuilder()

public AuthProviderServiceSettings.Builder toBuilder()

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

Returns
Type	Description
AuthProviderServiceSettings.Builder

Overrides

ClientSettings<SettingsT>.<B>toBuilder()

undeleteAuthProviderSettings()

public UnaryCallSettings<UndeleteAuthProviderRequest,AuthProvider> undeleteAuthProviderSettings()

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

Returns
Type	Description
UnaryCallSettings<UndeleteAuthProviderRequest,AuthProvider>

updateAuthProviderSettings()

public UnaryCallSettings<UpdateAuthProviderRequest,AuthProvider> updateAuthProviderSettings()

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

Returns
Type	Description
UnaryCallSettings<UpdateAuthProviderRequest,AuthProvider>