Package com.google.cloud.auditmanager.v1
Class AuditManagerSettings
java.lang.Object
com.google.api.gax.rpc.ClientSettings<AuditManagerSettings>
com.google.cloud.auditmanager.v1.AuditManagerSettings
@Generated("by gapic-generator-java")
public class AuditManagerSettings
extends ClientSettings<AuditManagerSettings>
Settings class to configure an instance of
AuditManagerClient.
The default instance has everything set to sensible defaults:
- The default service address (auditmanager.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](https://cloud.google.com/java/docs/reference/gax/latest/com.google.api.gax.retrying.RetrySettings) of enrollResource:
// 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
AuditManagerSettings.Builder auditManagerSettingsBuilder = AuditManagerSettings.newBuilder();
auditManagerSettingsBuilder
.enrollResourceSettings()
.setRetrySettings(
auditManagerSettingsBuilder
.enrollResourceSettings()
.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());
AuditManagerSettings auditManagerSettings = auditManagerSettingsBuilder.build();
Please refer to the [Client Side Retry
Guide](https://docs.cloud.google.com/java/docs/client-retries) 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 generateAuditReport:
// 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
AuditManagerSettings.Builder auditManagerSettingsBuilder = AuditManagerSettings.newBuilder();
TimedRetryAlgorithm timedRetryAlgorithm =
OperationalTimedPollAlgorithm.create(
RetrySettings.newBuilder()
.setInitialRetryDelayDuration(Duration.ofMillis(500))
.setRetryDelayMultiplier(1.5)
.setMaxRetryDelayDuration(Duration.ofMillis(5000))
.setTotalTimeoutDuration(Duration.ofHours(24))
.build());
auditManagerSettingsBuilder
.createClusterOperationSettings()
.setPollingAlgorithm(timedRetryAlgorithm)
.build();
-
Nested Class Summary
Nested ClassesModifier and TypeClassDescriptionstatic classBuilder for AuditManagerSettings. -
Constructor Summary
ConstructorsModifierConstructorDescriptionprotectedAuditManagerSettings(AuditManagerSettings.Builder settingsBuilder) -
Method Summary
Modifier and TypeMethodDescriptionstatic final AuditManagerSettingsReturns a builder for the default credentials for this service.Returns a builder for the default ExecutorProvider for this service.Returns a builder for the default gRPC ChannelProvider for this service.Returns a builder for the default REST ChannelProvider for this service.static TransportChannelProviderReturns the object with the settings used for calls to enrollResource.Returns the object with the settings used for calls to generateAuditReport.Returns the object with the settings used for calls to generateAuditReport.Returns the object with the settings used for calls to generateAuditScopeReport.Returns the object with the settings used for calls to getAuditReport.static StringReturns the default service endpoint.Returns the default service scopes.Returns the object with the settings used for calls to getLocation.Returns the object with the settings used for calls to getResourceEnrollmentStatus.PagedCallSettings<ListAuditReportsRequest,ListAuditReportsResponse, AuditManagerClient.ListAuditReportsPagedResponse> Returns the object with the settings used for calls to listAuditReports.PagedCallSettings<ListControlsRequest,ListControlsResponse, AuditManagerClient.ListControlsPagedResponse> Returns the object with the settings used for calls to listControls.PagedCallSettings<ListLocationsRequest,ListLocationsResponse, AuditManagerClient.ListLocationsPagedResponse> Returns the object with the settings used for calls to listLocations.PagedCallSettings<ListResourceEnrollmentStatusesRequest,ListResourceEnrollmentStatusesResponse, AuditManagerClient.ListResourceEnrollmentStatusesPagedResponse> Returns the object with the settings used for calls to listResourceEnrollmentStatuses.static AuditManagerSettings.BuilderReturns a new gRPC builder for this class.static AuditManagerSettings.BuildernewBuilder(ClientContext clientContext) Returns a new builder for this class.static AuditManagerSettings.BuilderReturns a new REST builder for this class.Returns a builder containing all the values of this settings class.Methods inherited from class com.google.api.gax.rpc.ClientSettings
getApiKey, getBackgroundExecutorProvider, getClock, getCredentialsProvider, getEndpoint, getExecutorProvider, getGdchApiAudience, getHeaderProvider, getInternalHeaderProvider, getQuotaProjectId, getStubSettings, getTransportChannelProvider, getUniverseDomain, getWatchdogCheckInterval, getWatchdogCheckIntervalDuration, getWatchdogProvider, toString
-
Constructor Details
-
AuditManagerSettings
- Throws:
IOException
-
-
Method Details
-
enrollResourceSettings
Returns the object with the settings used for calls to enrollResource. -
generateAuditScopeReportSettings
public UnaryCallSettings<GenerateAuditScopeReportRequest,AuditScopeReport> generateAuditScopeReportSettings()Returns the object with the settings used for calls to generateAuditScopeReport. -
generateAuditReportSettings
Returns the object with the settings used for calls to generateAuditReport. -
generateAuditReportOperationSettings
public OperationCallSettings<GenerateAuditReportRequest,AuditReport, generateAuditReportOperationSettings()OperationMetadata> Returns the object with the settings used for calls to generateAuditReport. -
listAuditReportsSettings
public PagedCallSettings<ListAuditReportsRequest,ListAuditReportsResponse, listAuditReportsSettings()AuditManagerClient.ListAuditReportsPagedResponse> Returns the object with the settings used for calls to listAuditReports. -
getAuditReportSettings
Returns the object with the settings used for calls to getAuditReport. -
getResourceEnrollmentStatusSettings
public UnaryCallSettings<GetResourceEnrollmentStatusRequest,ResourceEnrollmentStatus> getResourceEnrollmentStatusSettings()Returns the object with the settings used for calls to getResourceEnrollmentStatus. -
listResourceEnrollmentStatusesSettings
public PagedCallSettings<ListResourceEnrollmentStatusesRequest,ListResourceEnrollmentStatusesResponse, listResourceEnrollmentStatusesSettings()AuditManagerClient.ListResourceEnrollmentStatusesPagedResponse> Returns the object with the settings used for calls to listResourceEnrollmentStatuses. -
listControlsSettings
public PagedCallSettings<ListControlsRequest,ListControlsResponse, listControlsSettings()AuditManagerClient.ListControlsPagedResponse> Returns the object with the settings used for calls to listControls. -
listLocationsSettings
public PagedCallSettings<ListLocationsRequest,ListLocationsResponse, listLocationsSettings()AuditManagerClient.ListLocationsPagedResponse> Returns the object with the settings used for calls to listLocations. -
getLocationSettings
Returns the object with the settings used for calls to getLocation. -
create
- Throws:
IOException
-
defaultExecutorProviderBuilder
Returns a builder for the default ExecutorProvider for this service. -
getDefaultEndpoint
Returns the default service endpoint. -
getDefaultServiceScopes
Returns the default service scopes. -
defaultCredentialsProviderBuilder
Returns a builder for the default credentials for this service. -
defaultGrpcTransportProviderBuilder
Returns a builder for the default gRPC ChannelProvider for this service. -
defaultHttpJsonTransportProviderBuilder
@BetaApi public static InstantiatingHttpJsonChannelProvider.Builder defaultHttpJsonTransportProviderBuilder()Returns a builder for the default REST ChannelProvider for this service. -
defaultTransportChannelProvider
-
defaultApiClientHeaderProviderBuilder
-
newBuilder
Returns a new gRPC builder for this class. -
newHttpJsonBuilder
Returns a new REST builder for this class. -
newBuilder
Returns a new builder for this class. -
toBuilder
Returns a builder containing all the values of this settings class.- Specified by:
toBuilderin classClientSettings<AuditManagerSettings>
-